Linux Audio

Check our new training course

Loading...
v3.15
  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
 43typedef struct {
 44	u32             cl_boot;
 45	u32             cl_id;
 46} clientid_t;
 47
 48typedef struct {
 49	clientid_t	so_clid;
 50	u32		so_id;
 51} stateid_opaque_t;
 52
 53typedef 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
 65struct 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
 
 
 
 
 
 76struct 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/* For a deleg stateid kept around only to process free_stateid's: */
 83#define NFS4_REVOKED_DELEG_STID 16
 84	unsigned char sc_type;
 85	stateid_t sc_stateid;
 86	struct nfs4_client *sc_client;
 
 
 
 
 
 
 87};
 88
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 89struct nfs4_delegation {
 90	struct nfs4_stid	dl_stid; /* must be first field */
 91	struct list_head	dl_perfile;
 92	struct list_head	dl_perclnt;
 93	struct list_head	dl_recall_lru;  /* delegation recalled */
 94	atomic_t		dl_count;       /* ref count */
 95	struct nfs4_file	*dl_file;
 96	u32			dl_type;
 97	time_t			dl_time;
 98/* For recall: */
 99	struct knfsd_fh		dl_fh;
100	int			dl_retries;
101	struct nfsd4_callback	dl_recall;
102};
103
 
 
 
104/* client delegation callback info */
105struct nfs4_cb_conn {
106	/* SETCLIENTID info */
107	struct sockaddr_storage	cb_addr;
108	struct sockaddr_storage	cb_saddr;
109	size_t			cb_addrlen;
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 */
114};
115
116static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
117{
118	return container_of(s, struct nfs4_delegation, dl_stid);
119}
120
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		1024
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)
131
132struct nfsd4_slot {
133	u32	sl_seqid;
134	__be32	sl_status;
 
135	u32	sl_datalen;
136	u16	sl_opcnt;
137#define NFSD4_SLOT_INUSE	(1 << 0)
138#define NFSD4_SLOT_CACHETHIS	(1 << 1)
139#define NFSD4_SLOT_INITIALIZED	(1 << 2)
 
140	u8	sl_flags;
141	char	sl_data[];
142};
143
144struct nfsd4_channel_attrs {
145	u32		headerpadsz;
146	u32		maxreq_sz;
147	u32		maxresp_sz;
148	u32		maxresp_cached;
149	u32		maxops;
150	u32		maxreqs;
151	u32		nr_rdma_attrs;
152	u32		rdma_attrs;
153};
154
155struct nfsd4_cb_sec {
156	u32	flavor; /* (u32)(-1) used to mean "no valid flavor" */
157	kuid_t	uid;
158	kgid_t	gid;
159};
160
161struct nfsd4_create_session {
162	clientid_t			clientid;
163	struct nfs4_sessionid		sessionid;
164	u32				seqid;
165	u32				flags;
166	struct nfsd4_channel_attrs	fore_channel;
167	struct nfsd4_channel_attrs	back_channel;
168	u32				callback_prog;
169	struct nfsd4_cb_sec		cb_sec;
170};
171
172struct nfsd4_backchannel_ctl {
173	u32	bc_cb_program;
174	struct nfsd4_cb_sec		bc_cb_sec;
175};
176
177struct nfsd4_bind_conn_to_session {
178	struct nfs4_sessionid		sessionid;
179	u32				dir;
180};
181
182/* The single slot clientid cache structure */
183struct nfsd4_clid_slot {
184	u32				sl_seqid;
185	__be32				sl_status;
186	struct nfsd4_create_session	sl_cr_ses;
187};
188
189struct nfsd4_conn {
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;
196};
197
 
 
 
 
 
198struct nfsd4_session {
199	atomic_t		se_ref;
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
204	u32			se_flags;
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;
211	u32			se_cb_prog;
212	u32			se_cb_seq_nr;
213	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
214};
215
216extern void nfsd4_put_session(struct nfsd4_session *ses);
217
218/* formatted contents of nfs4_sessionid */
219struct nfsd4_sessionid {
220	clientid_t	clientid;
221	u32		sequence;
222	u32		reserved;
223};
224
225#define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
226
227/*
228 * struct nfs4_client - one per client.  Clientids live here.
229 * 	o Each nfs4_client is hashed by clientid.
230 *
231 * 	o Each nfs4_clients is also hashed by name 
232 * 	  (the opaque quantity initially sent by the client to identify itself).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
233 * 	  
234 *	o cl_perclient list is used to ensure no dangling stateowner references
235 *	  when we expire the nfs4_client
236 */
237struct nfs4_client {
238	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
239	struct rb_node		cl_namenode;	/* link into by-name trees */
 
240	struct list_head	cl_openowners;
241	struct idr		cl_stateids;	/* stateid lookup */
242	struct list_head	cl_delegations;
243	struct list_head	cl_revoked;	/* unacknowledged, revoked 4.1 state */
244	struct list_head        cl_lru;         /* tail queue */
 
 
 
245	struct xdr_netobj	cl_name; 	/* id generated by client */
246	nfs4_verifier		cl_verifier; 	/* generated by client */
247	time_t                  cl_time;        /* time of last lease renewal */
248	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
249	bool			cl_mach_cred;	/* SP4_MACH_CRED in force */
250	struct svc_cred		cl_cred; 	/* setclientid principal */
251	clientid_t		cl_clientid;	/* generated by server */
252	nfs4_verifier		cl_confirm;	/* generated by server */
253	u32			cl_minorversion;
 
 
 
 
254
255	/* for v4.0 and v4.1 callbacks: */
256	struct nfs4_cb_conn	cl_cb_conn;
257#define NFSD4_CLIENT_CB_UPDATE		(0)
258#define NFSD4_CLIENT_CB_KILL		(1)
259#define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
260#define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
261#define NFSD4_CLIENT_CONFIRMED		(4)	/* client is confirmed */
 
262#define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
263					 1 << NFSD4_CLIENT_CB_KILL)
264	unsigned long		cl_flags;
265	struct rpc_cred		*cl_cb_cred;
266	struct rpc_clnt		*cl_cb_client;
267	u32			cl_cb_ident;
268#define NFSD4_CB_UP		0
269#define NFSD4_CB_UNKNOWN	1
270#define NFSD4_CB_DOWN		2
271#define NFSD4_CB_FAULT		3
272	int			cl_cb_state;
273	struct nfsd4_callback	cl_cb_null;
274	struct nfsd4_session	*cl_cb_session;
275	struct list_head	cl_callbacks; /* list of in-progress callbacks */
276
277	/* for all client information that callback code might need: */
278	spinlock_t		cl_lock;
279
280	/* for nfs41 */
281	struct list_head	cl_sessions;
282	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
283	u32			cl_exchange_flags;
284	/* number of rpc's in progress over an associated session: */
285	atomic_t		cl_refcount;
 
 
 
 
 
286
287	/* for nfs41 callbacks */
288	/* We currently support a single back channel with a single slot */
289	unsigned long		cl_cb_slot_busy;
290	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
291						/* wait here for slots */
292	struct net		*net;
 
 
 
293};
294
295/* struct nfs4_client_reset
296 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
297 * upon lease reset, or from upcall to state_daemon (to read in state
298 * from non-volitile storage) upon reboot.
299 */
300struct nfs4_client_reclaim {
301	struct list_head	cr_strhash;	/* hash by cr_name */
302	struct nfs4_client	*cr_clp;	/* pointer to associated clp */
303	char			cr_recdir[HEXDIR_LEN]; /* recover dir */
 
304};
305
306static inline void
307update_stateid(stateid_t *stateid)
308{
309	stateid->si_generation++;
310	/* Wraparound recommendation from 3530bis-13 9.1.3.2: */
311	if (stateid->si_generation == 0)
312		stateid->si_generation = 1;
313}
314
315/* A reasonable value for REPLAY_ISIZE was estimated as follows:  
316 * The OPEN response, typically the largest, requires 
317 *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
318 *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
319 *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
320 */
321
322#define NFSD4_REPLAY_ISIZE       112 
323
324/*
325 * Replay buffer, where the result of the last seqid-mutating operation 
326 * is cached. 
327 */
328struct nfs4_replay {
329	__be32			rp_status;
330	unsigned int		rp_buflen;
331	char			*rp_buf;
332	struct knfsd_fh		rp_openfh;
 
333	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
334};
335
 
 
 
 
 
 
 
 
 
 
 
 
 
336struct nfs4_stateowner {
337	struct list_head        so_strhash;   /* hash by op_name */
338	struct list_head        so_stateids;
339	struct nfs4_client *    so_client;
340	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 
341	 * sequence id expected from the client: */
342	u32                     so_seqid;
343	struct xdr_netobj       so_owner;     /* open owner name */
344	struct nfs4_replay	so_replay;
345	bool			so_is_open_owner;
 
346};
347
 
 
 
 
 
 
348struct nfs4_openowner {
349	struct nfs4_stateowner	oo_owner; /* must be first field */
350	struct list_head        oo_perclient;
351	/*
352	 * We keep around openowners a little while after last close,
353	 * which saves clients from having to confirm, and allows us to
354	 * handle close replays if they come soon enough.  The close_lru
355	 * is a list of such openowners, to be reaped by the laundromat
356	 * thread eventually if they remain unused:
357	 */
358	struct list_head	oo_close_lru;
359	struct nfs4_ol_stateid *oo_last_closed_stid;
360	time_t			oo_time; /* time of placement on so_close_lru */
361#define NFS4_OO_CONFIRMED   1
362#define NFS4_OO_NEW         4
363	unsigned char		oo_flags;
364};
365
 
 
 
 
 
366struct nfs4_lockowner {
367	struct nfs4_stateowner	lo_owner; /* must be first element */
368	struct list_head	lo_owner_ino_hash; /* hash by owner,file */
369	struct list_head        lo_perstateid;
370	struct list_head	lo_list; /* for temporary uses */
371};
372
373static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
374{
375	return container_of(so, struct nfs4_openowner, oo_owner);
376}
377
378static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
379{
380	return container_of(so, struct nfs4_lockowner, lo_owner);
381}
382
383/* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
384struct nfs4_file {
385	atomic_t		fi_ref;
386	struct hlist_node       fi_hash;    /* hash by "struct inode *" */
 
387	struct list_head        fi_stateids;
388	struct list_head	fi_delegations;
 
 
 
 
389	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
390	struct file *		fi_fds[3];
391	/*
392	 * Each open or lock stateid contributes 0-4 to the counts
393	 * below depending on which bits are set in st_access_bitmap:
394	 *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
395	 *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
396	 *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
397	 */
398	atomic_t		fi_access[2];
399	struct file		*fi_deleg_file;
400	struct file_lock	*fi_lease;
401	atomic_t		fi_delegees;
402	struct inode		*fi_inode;
403	bool			fi_had_conflict;
 
 
 
 
404};
405
406/* XXX: for first cut may fall back on returning file that doesn't work
407 * at all? */
408static inline struct file *find_writeable_file(struct nfs4_file *f)
409{
410	if (f->fi_fds[O_WRONLY])
411		return f->fi_fds[O_WRONLY];
412	return f->fi_fds[O_RDWR];
413}
414
415static inline struct file *find_readable_file(struct nfs4_file *f)
416{
417	if (f->fi_fds[O_RDONLY])
418		return f->fi_fds[O_RDONLY];
419	return f->fi_fds[O_RDWR];
420}
 
 
 
 
 
 
 
 
 
 
 
421
422static inline struct file *find_any_file(struct nfs4_file *f)
423{
424	if (f->fi_fds[O_RDWR])
425		return f->fi_fds[O_RDWR];
426	else if (f->fi_fds[O_WRONLY])
427		return f->fi_fds[O_WRONLY];
428	else
429		return f->fi_fds[O_RDONLY];
430}
431
432/* "ol" stands for "Open or Lock".  Better suggestions welcome. */
433struct nfs4_ol_stateid {
434	struct nfs4_stid    st_stid; /* must be first field */
435	struct list_head              st_perfile;
436	struct list_head              st_perstateowner;
437	struct list_head              st_lockowners;
438	struct nfs4_stateowner      * st_stateowner;
439	struct nfs4_file            * st_file;
440	unsigned long                 st_access_bmap;
441	unsigned long                 st_deny_bmap;
442	struct nfs4_ol_stateid         * st_openstp;
 
443};
444
445static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
446{
447	return container_of(s, struct nfs4_ol_stateid, st_stid);
448}
449
450/* flags for preprocess_seqid_op() */
451#define RD_STATE	        0x00000010
452#define WR_STATE	        0x00000020
453
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
454struct nfsd4_compound_state;
455struct nfsd_net;
 
456
457extern __be32 nfs4_preprocess_stateid_op(struct net *net,
458		struct nfsd4_compound_state *cstate,
459		stateid_t *stateid, int flags, struct file **filp);
460extern void nfs4_lock_state(void);
461extern void nfs4_unlock_state(void);
 
 
 
 
 
 
 
 
 
 
 
462void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
463extern void nfs4_release_reclaim(struct nfsd_net *);
464extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
465							struct nfsd_net *nn);
466extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions, struct nfsd_net *nn);
467extern void nfs4_free_openowner(struct nfs4_openowner *);
468extern void nfs4_free_lockowner(struct nfs4_lockowner *);
469extern int set_callback_cred(void);
470extern void nfsd4_init_callback(struct nfsd4_callback *);
471extern void nfsd4_probe_callback(struct nfs4_client *clp);
472extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
473extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
474extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 
 
475extern int nfsd4_create_callback_queue(void);
476extern void nfsd4_destroy_callback_queue(void);
477extern void nfsd4_shutdown_callback(struct nfs4_client *);
478extern void nfs4_put_delegation(struct nfs4_delegation *dp);
479extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
480							struct nfsd_net *nn);
481extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
482extern void put_client_renew(struct nfs4_client *clp);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
483
484/* nfs4recover operations */
485extern int nfsd4_client_tracking_init(struct net *net);
486extern void nfsd4_client_tracking_exit(struct net *net);
487extern void nfsd4_client_record_create(struct nfs4_client *clp);
488extern void nfsd4_client_record_remove(struct nfs4_client *clp);
489extern int nfsd4_client_record_check(struct nfs4_client *clp);
490extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
491
492/* nfs fault injection functions */
493#ifdef CONFIG_NFSD_FAULT_INJECTION
494int nfsd_fault_inject_init(void);
495void nfsd_fault_inject_cleanup(void);
496u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
497struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);
498
499u64 nfsd_forget_client(struct nfs4_client *, u64);
500u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
501u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
502u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
503u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
504
505u64 nfsd_print_client(struct nfs4_client *, u64);
506u64 nfsd_print_client_locks(struct nfs4_client *, u64);
507u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
508u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
 
 
 
 
 
 
 
509#else /* CONFIG_NFSD_FAULT_INJECTION */
510static inline int nfsd_fault_inject_init(void) { return 0; }
511static inline void nfsd_fault_inject_cleanup(void) {}
512#endif /* CONFIG_NFSD_FAULT_INJECTION */
513
514#endif   /* NFSD4_STATE_H */
v5.9
  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/refcount.h>
 40#include <linux/sunrpc/svc_xprt.h>
 
 41#include "nfsfh.h"
 42#include "nfsd.h"
 43
 44typedef struct {
 45	u32             cl_boot;
 46	u32             cl_id;
 47} clientid_t;
 48
 49typedef struct {
 50	clientid_t	so_clid;
 51	u32		so_id;
 52} stateid_opaque_t;
 53
 54typedef struct {
 55	u32                     si_generation;
 56	stateid_opaque_t        si_opaque;
 57} stateid_t;
 58
 59typedef struct {
 60	stateid_t		stid;
 61#define NFS4_COPY_STID 1
 62#define NFS4_COPYNOTIFY_STID 2
 63	unsigned char		sc_type;
 64	refcount_t		sc_count;
 65} copy_stateid_t;
 66
 67struct nfsd4_callback {
 
 68	struct nfs4_client *cb_clp;
 
 
 69	struct rpc_message cb_msg;
 70	const struct nfsd4_callback_ops *cb_ops;
 71	struct work_struct cb_work;
 72	int cb_seq_status;
 73	int cb_status;
 74	bool cb_need_restart;
 75	bool cb_holds_slot;
 76};
 77
 78struct nfsd4_callback_ops {
 79	void (*prepare)(struct nfsd4_callback *);
 80	int (*done)(struct nfsd4_callback *, struct rpc_task *);
 81	void (*release)(struct nfsd4_callback *);
 82};
 83
 84/*
 85 * A core object that represents a "common" stateid. These are generally
 86 * embedded within the different (more specific) stateid objects and contain
 87 * fields that are of general use to any stateid.
 88 */
 89struct nfs4_stid {
 90	refcount_t		sc_count;
 91#define NFS4_OPEN_STID 1
 92#define NFS4_LOCK_STID 2
 93#define NFS4_DELEG_STID 4
 94/* For an open stateid kept around *only* to process close replays: */
 95#define NFS4_CLOSED_STID 8
 96/* For a deleg stateid kept around only to process free_stateid's: */
 97#define NFS4_REVOKED_DELEG_STID 16
 98#define NFS4_CLOSED_DELEG_STID 32
 99#define NFS4_LAYOUT_STID 64
100	struct list_head	sc_cp_list;
101	unsigned char		sc_type;
102	stateid_t		sc_stateid;
103	spinlock_t		sc_lock;
104	struct nfs4_client	*sc_client;
105	struct nfs4_file	*sc_file;
106	void			(*sc_free)(struct nfs4_stid *);
107};
108
109/* Keep a list of stateids issued by the COPY_NOTIFY, associate it with the
110 * parent OPEN/LOCK/DELEG stateid.
111 */
112struct nfs4_cpntf_state {
113	copy_stateid_t		cp_stateid;
114	struct list_head	cp_list;	/* per parent nfs4_stid */
115	stateid_t		cp_p_stateid;	/* copy of parent's stateid */
116	clientid_t		cp_p_clid;	/* copy of parent's clid */
117	time64_t		cpntf_time;	/* last time stateid used */
118};
119
120/*
121 * Represents a delegation stateid. The nfs4_client holds references to these
122 * and they are put when it is being destroyed or when the delegation is
123 * returned by the client:
124 *
125 * o 1 reference as long as a delegation is still in force (taken when it's
126 *   alloc'd, put when it's returned or revoked)
127 *
128 * o 1 reference as long as a recall rpc is in progress (taken when the lease
129 *   is broken, put when the rpc exits)
130 *
131 * o 1 more ephemeral reference for each nfsd thread currently doing something
132 *   with that delegation without holding the cl_lock
133 *
134 * If the server attempts to recall a delegation and the client doesn't do so
135 * before a timeout, the server may also revoke the delegation. In that case,
136 * the object will either be destroyed (v4.0) or moved to a per-client list of
137 * revoked delegations (v4.1+).
138 *
139 * This object is a superset of the nfs4_stid.
140 */
141struct nfs4_delegation {
142	struct nfs4_stid	dl_stid; /* must be first field */
143	struct list_head	dl_perfile;
144	struct list_head	dl_perclnt;
145	struct list_head	dl_recall_lru;  /* delegation recalled */
146	struct nfs4_clnt_odstate *dl_clnt_odstate;
 
147	u32			dl_type;
148	time64_t		dl_time;
149/* For recall: */
 
150	int			dl_retries;
151	struct nfsd4_callback	dl_recall;
152};
153
154#define cb_to_delegation(cb) \
155	container_of(cb, struct nfs4_delegation, dl_recall)
156
157/* client delegation callback info */
158struct nfs4_cb_conn {
159	/* SETCLIENTID info */
160	struct sockaddr_storage	cb_addr;
161	struct sockaddr_storage	cb_saddr;
162	size_t			cb_addrlen;
163	u32                     cb_prog; /* used only in 4.0 case;
164					    per-session otherwise */
165	u32                     cb_ident;	/* minorversion 0 only */
166	struct svc_xprt		*cb_xprt;	/* minorversion 1 only */
167};
168
169static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
170{
171	return container_of(s, struct nfs4_delegation, dl_stid);
172}
173
174/* Maximum number of slots per session. 160 is useful for long haul TCP */
175#define NFSD_MAX_SLOTS_PER_SESSION     160
176/* Maximum number of operations per session compound */
177#define NFSD_MAX_OPS_PER_COMPOUND	16
178/* Maximum  session per slot cache size */
179#define NFSD_SLOT_CACHE_SIZE		2048
180/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
181#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION	32
182#define NFSD_MAX_MEM_PER_SESSION  \
183		(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
184
185struct nfsd4_slot {
186	u32	sl_seqid;
187	__be32	sl_status;
188	struct svc_cred sl_cred;
189	u32	sl_datalen;
190	u16	sl_opcnt;
191#define NFSD4_SLOT_INUSE	(1 << 0)
192#define NFSD4_SLOT_CACHETHIS	(1 << 1)
193#define NFSD4_SLOT_INITIALIZED	(1 << 2)
194#define NFSD4_SLOT_CACHED	(1 << 3)
195	u8	sl_flags;
196	char	sl_data[];
197};
198
199struct nfsd4_channel_attrs {
200	u32		headerpadsz;
201	u32		maxreq_sz;
202	u32		maxresp_sz;
203	u32		maxresp_cached;
204	u32		maxops;
205	u32		maxreqs;
206	u32		nr_rdma_attrs;
207	u32		rdma_attrs;
208};
209
210struct nfsd4_cb_sec {
211	u32	flavor; /* (u32)(-1) used to mean "no valid flavor" */
212	kuid_t	uid;
213	kgid_t	gid;
214};
215
216struct nfsd4_create_session {
217	clientid_t			clientid;
218	struct nfs4_sessionid		sessionid;
219	u32				seqid;
220	u32				flags;
221	struct nfsd4_channel_attrs	fore_channel;
222	struct nfsd4_channel_attrs	back_channel;
223	u32				callback_prog;
224	struct nfsd4_cb_sec		cb_sec;
225};
226
227struct nfsd4_backchannel_ctl {
228	u32	bc_cb_program;
229	struct nfsd4_cb_sec		bc_cb_sec;
230};
231
232struct nfsd4_bind_conn_to_session {
233	struct nfs4_sessionid		sessionid;
234	u32				dir;
235};
236
237/* The single slot clientid cache structure */
238struct nfsd4_clid_slot {
239	u32				sl_seqid;
240	__be32				sl_status;
241	struct nfsd4_create_session	sl_cr_ses;
242};
243
244struct nfsd4_conn {
245	struct list_head cn_persession;
246	struct svc_xprt *cn_xprt;
247	struct svc_xpt_user cn_xpt_user;
248	struct nfsd4_session *cn_session;
249/* CDFC4_FORE, CDFC4_BACK: */
250	unsigned char cn_flags;
251};
252
253/*
254 * Representation of a v4.1+ session. These are refcounted in a similar fashion
255 * to the nfs4_client. References are only taken when the server is actively
256 * working on the object (primarily during the processing of compounds).
257 */
258struct nfsd4_session {
259	atomic_t		se_ref;
260	struct list_head	se_hash;	/* hash by sessionid */
261	struct list_head	se_perclnt;
262/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
263#define NFS4_SESSION_DEAD	0x010
264	u32			se_flags;
265	struct nfs4_client	*se_client;
266	struct nfs4_sessionid	se_sessionid;
267	struct nfsd4_channel_attrs se_fchannel;
268	struct nfsd4_channel_attrs se_bchannel;
269	struct nfsd4_cb_sec	se_cb_sec;
270	struct list_head	se_conns;
271	u32			se_cb_prog;
272	u32			se_cb_seq_nr;
273	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
274};
275
 
 
276/* formatted contents of nfs4_sessionid */
277struct nfsd4_sessionid {
278	clientid_t	clientid;
279	u32		sequence;
280	u32		reserved;
281};
282
283#define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
284
285/*
286 * struct nfs4_client - one per client.  Clientids live here.
 
287 *
288 * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
289 * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
290 * Each nfsd_net_ns object contains a set of these and they are tracked via
291 * short and long form clientid. They are hashed and searched for under the
292 * per-nfsd_net client_lock spinlock.
293 *
294 * References to it are only held during the processing of compounds, and in
295 * certain other operations. In their "resting state" they have a refcount of
296 * 0. If they are not renewed within a lease period, they become eligible for
297 * destruction by the laundromat.
298 *
299 * These objects can also be destroyed prematurely by the fault injection code,
300 * or if the client sends certain forms of SETCLIENTID or EXCHANGE_ID updates.
301 * Care is taken *not* to do this however when the objects have an elevated
302 * refcount.
303 *
304 * o Each nfs4_client is hashed by clientid
305 *
306 * o Each nfs4_clients is also hashed by name (the opaque quantity initially
307 *   sent by the client to identify itself).
308 * 	  
309 * o cl_perclient list is used to ensure no dangling stateowner references
310 *   when we expire the nfs4_client
311 */
312struct nfs4_client {
313	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
314	struct rb_node		cl_namenode;	/* link into by-name trees */
315	struct list_head	*cl_ownerstr_hashtbl;
316	struct list_head	cl_openowners;
317	struct idr		cl_stateids;	/* stateid lookup */
318	struct list_head	cl_delegations;
319	struct list_head	cl_revoked;	/* unacknowledged, revoked 4.1 state */
320	struct list_head        cl_lru;         /* tail queue */
321#ifdef CONFIG_NFSD_PNFS
322	struct list_head	cl_lo_states;	/* outstanding layout states */
323#endif
324	struct xdr_netobj	cl_name; 	/* id generated by client */
325	nfs4_verifier		cl_verifier; 	/* generated by client */
326	time64_t		cl_time;	/* time of last lease renewal */
327	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
328	bool			cl_mach_cred;	/* SP4_MACH_CRED in force */
329	struct svc_cred		cl_cred; 	/* setclientid principal */
330	clientid_t		cl_clientid;	/* generated by server */
331	nfs4_verifier		cl_confirm;	/* generated by server */
332	u32			cl_minorversion;
333	/* NFSv4.1 client implementation id: */
334	struct xdr_netobj	cl_nii_domain;
335	struct xdr_netobj	cl_nii_name;
336	struct timespec64	cl_nii_time;
337
338	/* for v4.0 and v4.1 callbacks: */
339	struct nfs4_cb_conn	cl_cb_conn;
340#define NFSD4_CLIENT_CB_UPDATE		(0)
341#define NFSD4_CLIENT_CB_KILL		(1)
342#define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
343#define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
344#define NFSD4_CLIENT_CONFIRMED		(4)	/* client is confirmed */
345#define NFSD4_CLIENT_UPCALL_LOCK	(5)	/* upcall serialization */
346#define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
347					 1 << NFSD4_CLIENT_CB_KILL)
348	unsigned long		cl_flags;
349	const struct cred	*cl_cb_cred;
350	struct rpc_clnt		*cl_cb_client;
351	u32			cl_cb_ident;
352#define NFSD4_CB_UP		0
353#define NFSD4_CB_UNKNOWN	1
354#define NFSD4_CB_DOWN		2
355#define NFSD4_CB_FAULT		3
356	int			cl_cb_state;
357	struct nfsd4_callback	cl_cb_null;
358	struct nfsd4_session	*cl_cb_session;
 
359
360	/* for all client information that callback code might need: */
361	spinlock_t		cl_lock;
362
363	/* for nfs41 */
364	struct list_head	cl_sessions;
365	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
366	u32			cl_exchange_flags;
367	/* number of rpc's in progress over an associated session: */
368	atomic_t		cl_rpc_users;
369	struct nfsdfs_client	cl_nfsdfs;
370	struct nfs4_op_map      cl_spo_must_allow;
371
372	/* debugging info directory under nfsd/clients/ : */
373	struct dentry		*cl_nfsd_dentry;
374
375	/* for nfs41 callbacks */
376	/* We currently support a single back channel with a single slot */
377	unsigned long		cl_cb_slot_busy;
378	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
379						/* wait here for slots */
380	struct net		*net;
381	struct list_head	async_copies;	/* list of async copies */
382	spinlock_t		async_lock;	/* lock for async copies */
383	atomic_t		cl_cb_inflight;	/* Outstanding callbacks */
384};
385
386/* struct nfs4_client_reset
387 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
388 * upon lease reset, or from upcall to state_daemon (to read in state
389 * from non-volitile storage) upon reboot.
390 */
391struct nfs4_client_reclaim {
392	struct list_head	cr_strhash;	/* hash by cr_name */
393	struct nfs4_client	*cr_clp;	/* pointer to associated clp */
394	struct xdr_netobj	cr_name;	/* recovery dir name */
395	struct xdr_netobj	cr_princhash;
396};
397
 
 
 
 
 
 
 
 
 
398/* A reasonable value for REPLAY_ISIZE was estimated as follows:  
399 * The OPEN response, typically the largest, requires 
400 *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
401 *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
402 *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
403 */
404
405#define NFSD4_REPLAY_ISIZE       112 
406
407/*
408 * Replay buffer, where the result of the last seqid-mutating operation 
409 * is cached. 
410 */
411struct nfs4_replay {
412	__be32			rp_status;
413	unsigned int		rp_buflen;
414	char			*rp_buf;
415	struct knfsd_fh		rp_openfh;
416	struct mutex		rp_mutex;
417	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
418};
419
420struct nfs4_stateowner;
421
422struct nfs4_stateowner_operations {
423	void (*so_unhash)(struct nfs4_stateowner *);
424	void (*so_free)(struct nfs4_stateowner *);
425};
426
427/*
428 * A core object that represents either an open or lock owner. The object and
429 * lock owner objects have one of these embedded within them. Refcounts and
430 * other fields common to both owner types are contained within these
431 * structures.
432 */
433struct nfs4_stateowner {
434	struct list_head			so_strhash;
435	struct list_head			so_stateids;
436	struct nfs4_client			*so_client;
437	const struct nfs4_stateowner_operations	*so_ops;
438	/* after increment in nfsd4_bump_seqid, represents the next
439	 * sequence id expected from the client: */
440	atomic_t				so_count;
441	u32					so_seqid;
442	struct xdr_netobj			so_owner; /* open owner name */
443	struct nfs4_replay			so_replay;
444	bool					so_is_open_owner;
445};
446
447/*
448 * When a file is opened, the client provides an open state owner opaque string
449 * that indicates the "owner" of that open. These objects are refcounted.
450 * References to it are held by each open state associated with it. This object
451 * is a superset of the nfs4_stateowner struct.
452 */
453struct nfs4_openowner {
454	struct nfs4_stateowner	oo_owner; /* must be first field */
455	struct list_head        oo_perclient;
456	/*
457	 * We keep around openowners a little while after last close,
458	 * which saves clients from having to confirm, and allows us to
459	 * handle close replays if they come soon enough.  The close_lru
460	 * is a list of such openowners, to be reaped by the laundromat
461	 * thread eventually if they remain unused:
462	 */
463	struct list_head	oo_close_lru;
464	struct nfs4_ol_stateid *oo_last_closed_stid;
465	time64_t		oo_time; /* time of placement on so_close_lru */
466#define NFS4_OO_CONFIRMED   1
 
467	unsigned char		oo_flags;
468};
469
470/*
471 * Represents a generic "lockowner". Similar to an openowner. References to it
472 * are held by the lock stateids that are created on its behalf. This object is
473 * a superset of the nfs4_stateowner struct.
474 */
475struct nfs4_lockowner {
476	struct nfs4_stateowner	lo_owner;	/* must be first element */
477	struct list_head	lo_blocked;	/* blocked file_locks */
 
 
478};
479
480static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
481{
482	return container_of(so, struct nfs4_openowner, oo_owner);
483}
484
485static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
486{
487	return container_of(so, struct nfs4_lockowner, lo_owner);
488}
489
490/*
491 * Per-client state indicating no. of opens and outstanding delegations
492 * on a file from a particular client.'od' stands for 'open & delegation'
493 */
494struct nfs4_clnt_odstate {
495	struct nfs4_client	*co_client;
496	struct nfs4_file	*co_file;
497	struct list_head	co_perfile;
498	refcount_t		co_odcount;
499};
500
501/*
502 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
503 *
504 * These objects are global. nfsd keeps one instance of a nfs4_file per
505 * filehandle (though it may keep multiple file descriptors for each). Each
506 * inode can have multiple filehandles associated with it, so there is
507 * (potentially) a many to one relationship between this struct and struct
508 * inode.
509 *
510 * These are hashed by filehandle in the file_hashtbl, which is protected by
511 * the global state_lock spinlock.
512 */
513struct nfs4_file {
514	refcount_t		fi_ref;
515	spinlock_t		fi_lock;
516	struct hlist_node       fi_hash;	/* hash on fi_fhandle */
517	struct list_head        fi_stateids;
518	union {
519		struct list_head	fi_delegations;
520		struct rcu_head		fi_rcu;
521	};
522	struct list_head	fi_clnt_odstate;
523	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
524	struct nfsd_file	*fi_fds[3];
525	/*
526	 * Each open or lock stateid contributes 0-4 to the counts
527	 * below depending on which bits are set in st_access_bitmap:
528	 *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
529	 *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
530	 *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
531	 */
532	atomic_t		fi_access[2];
533	u32			fi_share_deny;
534	struct nfsd_file	*fi_deleg_file;
535	int			fi_delegees;
536	struct knfsd_fh		fi_fhandle;
537	bool			fi_had_conflict;
538#ifdef CONFIG_NFSD_PNFS
539	struct list_head	fi_lo_states;
540	atomic_t		fi_lo_recalls;
541#endif
542};
543
544/*
545 * A generic struct representing either a open or lock stateid. The nfs4_client
546 * holds a reference to each of these objects, and they in turn hold a
547 * reference to their respective stateowners. The client's reference is
548 * released in response to a close or unlock (depending on whether it's an open
549 * or lock stateid) or when the client is being destroyed.
550 *
551 * In the case of v4.0 open stateids, these objects are preserved for a little
552 * while after close in order to handle CLOSE replays. Those are eventually
553 * reclaimed via a LRU scheme by the laundromat.
554 *
555 * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
556 * Better suggestions welcome.
557 */
558struct nfs4_ol_stateid {
559	struct nfs4_stid		st_stid;
560	struct list_head		st_perfile;
561	struct list_head		st_perstateowner;
562	struct list_head		st_locks;
563	struct nfs4_stateowner		*st_stateowner;
564	struct nfs4_clnt_odstate	*st_clnt_odstate;
565	unsigned char			st_access_bmap;
566	unsigned char			st_deny_bmap;
567	struct nfs4_ol_stateid		*st_openstp;
568	struct mutex			st_mutex;
569};
570
571static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
572{
573	return container_of(s, struct nfs4_ol_stateid, st_stid);
 
 
 
 
 
574}
575
576struct nfs4_layout_stateid {
577	struct nfs4_stid		ls_stid;
578	struct list_head		ls_perclnt;
579	struct list_head		ls_perfile;
580	spinlock_t			ls_lock;
581	struct list_head		ls_layouts;
582	u32				ls_layout_type;
583	struct nfsd_file		*ls_file;
584	struct nfsd4_callback		ls_recall;
585	stateid_t			ls_recall_sid;
586	bool				ls_recalled;
587	struct mutex			ls_mutex;
588};
589
590static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s)
591{
592	return container_of(s, struct nfs4_layout_stateid, ls_stid);
593}
594
595/* flags for preprocess_seqid_op() */
596#define RD_STATE	        0x00000010
597#define WR_STATE	        0x00000020
598
599enum nfsd4_cb_op {
600	NFSPROC4_CLNT_CB_NULL = 0,
601	NFSPROC4_CLNT_CB_RECALL,
602	NFSPROC4_CLNT_CB_LAYOUT,
603	NFSPROC4_CLNT_CB_OFFLOAD,
604	NFSPROC4_CLNT_CB_SEQUENCE,
605	NFSPROC4_CLNT_CB_NOTIFY_LOCK,
606};
607
608/* Returns true iff a is later than b: */
609static inline bool nfsd4_stateid_generation_after(stateid_t *a, stateid_t *b)
610{
611	return (s32)(a->si_generation - b->si_generation) > 0;
612}
613
614/*
615 * When a client tries to get a lock on a file, we set one of these objects
616 * on the blocking lock. When the lock becomes free, we can then issue a
617 * CB_NOTIFY_LOCK to the server.
618 */
619struct nfsd4_blocked_lock {
620	struct list_head	nbl_list;
621	struct list_head	nbl_lru;
622	time64_t		nbl_time;
623	struct file_lock	nbl_lock;
624	struct knfsd_fh		nbl_fh;
625	struct nfsd4_callback	nbl_cb;
626};
627
628struct nfsd4_compound_state;
629struct nfsd_net;
630struct nfsd4_copy;
631
632extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp,
633		struct nfsd4_compound_state *cstate, struct svc_fh *fhp,
634		stateid_t *stateid, int flags, struct nfsd_file **filp,
635		struct nfs4_stid **cstid);
636__be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate,
637		     stateid_t *stateid, unsigned char typemask,
638		     struct nfs4_stid **s, struct nfsd_net *nn);
639struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl, struct kmem_cache *slab,
640				  void (*sc_free)(struct nfs4_stid *));
641int nfs4_init_copy_state(struct nfsd_net *nn, struct nfsd4_copy *copy);
642void nfs4_free_copy_state(struct nfsd4_copy *copy);
643struct nfs4_cpntf_state *nfs4_alloc_init_cpntf_state(struct nfsd_net *nn,
644			struct nfs4_stid *p_stid);
645void nfs4_unhash_stid(struct nfs4_stid *s);
646void nfs4_put_stid(struct nfs4_stid *s);
647void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid);
648void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
649extern void nfs4_release_reclaim(struct nfsd_net *);
650extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct xdr_netobj name,
651							struct nfsd_net *nn);
652extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
653		struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
 
 
 
654extern void nfsd4_probe_callback(struct nfs4_client *clp);
655extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
656extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
657extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
658		const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
659extern void nfsd4_run_cb(struct nfsd4_callback *cb);
660extern int nfsd4_create_callback_queue(void);
661extern void nfsd4_destroy_callback_queue(void);
662extern void nfsd4_shutdown_callback(struct nfs4_client *);
663extern void nfsd4_shutdown_copy(struct nfs4_client *clp);
664extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
665extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(struct xdr_netobj name,
666				struct xdr_netobj princhash, struct nfsd_net *nn);
667extern bool nfs4_has_reclaimed_state(struct xdr_netobj name, struct nfsd_net *nn);
668
669struct nfs4_file *find_file(struct knfsd_fh *fh);
670void put_nfs4_file(struct nfs4_file *fi);
671extern void nfs4_put_copy(struct nfsd4_copy *copy);
672extern struct nfsd4_copy *
673find_async_copy(struct nfs4_client *clp, stateid_t *staetid);
674extern void nfs4_put_cpntf_state(struct nfsd_net *nn,
675				 struct nfs4_cpntf_state *cps);
676extern __be32 manage_cpntf_state(struct nfsd_net *nn, stateid_t *st,
677				 struct nfs4_client *clp,
678				 struct nfs4_cpntf_state **cps);
679static inline void get_nfs4_file(struct nfs4_file *fi)
680{
681	refcount_inc(&fi->fi_ref);
682}
683struct nfsd_file *find_any_file(struct nfs4_file *f);
684
685/* grace period management */
686void nfsd4_end_grace(struct nfsd_net *nn);
687
688/* nfs4recover operations */
689extern int nfsd4_client_tracking_init(struct net *net);
690extern void nfsd4_client_tracking_exit(struct net *net);
691extern void nfsd4_client_record_create(struct nfs4_client *clp);
692extern void nfsd4_client_record_remove(struct nfs4_client *clp);
693extern int nfsd4_client_record_check(struct nfs4_client *clp);
694extern void nfsd4_record_grace_done(struct nfsd_net *nn);
695
696/* nfs fault injection functions */
697#ifdef CONFIG_NFSD_FAULT_INJECTION
698void nfsd_fault_inject_init(void);
699void nfsd_fault_inject_cleanup(void);
 
 
700
701u64 nfsd_inject_print_clients(void);
702u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
703u64 nfsd_inject_forget_clients(u64);
704
705u64 nfsd_inject_print_locks(void);
706u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
707u64 nfsd_inject_forget_locks(u64);
708
709u64 nfsd_inject_print_openowners(void);
710u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
711u64 nfsd_inject_forget_openowners(u64);
712
713u64 nfsd_inject_print_delegations(void);
714u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
715u64 nfsd_inject_forget_delegations(u64);
716u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
717u64 nfsd_inject_recall_delegations(u64);
718#else /* CONFIG_NFSD_FAULT_INJECTION */
719static inline void nfsd_fault_inject_init(void) {}
720static inline void nfsd_fault_inject_cleanup(void) {}
721#endif /* CONFIG_NFSD_FAULT_INJECTION */
722
723#endif   /* NFSD4_STATE_H */