xref: /openbmc/linux/fs/nfs/nfs4_fs.h (revision e40573a4)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * linux/fs/nfs/nfs4_fs.h
4  *
5  * Copyright (C) 2005 Trond Myklebust
6  *
7  * NFSv4-specific filesystem definitions and declarations
8  */
9 
10 #ifndef __LINUX_FS_NFS_NFS4_FS_H
11 #define __LINUX_FS_NFS_NFS4_FS_H
12 
13 #if defined(CONFIG_NFS_V4_2)
14 #define NFS4_MAX_MINOR_VERSION 2
15 #elif defined(CONFIG_NFS_V4_1)
16 #define NFS4_MAX_MINOR_VERSION 1
17 #else
18 #define NFS4_MAX_MINOR_VERSION 0
19 #endif
20 
21 #if IS_ENABLED(CONFIG_NFS_V4)
22 
23 #define NFS4_MAX_LOOP_ON_RECOVER (10)
24 
25 #include <linux/seqlock.h>
26 
27 struct idmap;
28 
29 enum nfs4_client_state {
30 	NFS4CLNT_MANAGER_RUNNING  = 0,
31 	NFS4CLNT_CHECK_LEASE,
32 	NFS4CLNT_LEASE_EXPIRED,
33 	NFS4CLNT_RECLAIM_REBOOT,
34 	NFS4CLNT_RECLAIM_NOGRACE,
35 	NFS4CLNT_DELEGRETURN,
36 	NFS4CLNT_SESSION_RESET,
37 	NFS4CLNT_LEASE_CONFIRM,
38 	NFS4CLNT_SERVER_SCOPE_MISMATCH,
39 	NFS4CLNT_PURGE_STATE,
40 	NFS4CLNT_BIND_CONN_TO_SESSION,
41 	NFS4CLNT_MOVED,
42 	NFS4CLNT_LEASE_MOVED,
43 	NFS4CLNT_DELEGATION_EXPIRED,
44 	NFS4CLNT_RUN_MANAGER,
45 	NFS4CLNT_MANAGER_AVAILABLE,
46 	NFS4CLNT_RECALL_RUNNING,
47 	NFS4CLNT_RECALL_ANY_LAYOUT_READ,
48 	NFS4CLNT_RECALL_ANY_LAYOUT_RW,
49 	NFS4CLNT_DELEGRETURN_DELAYED,
50 };
51 
52 #define NFS4_RENEW_TIMEOUT		0x01
53 #define NFS4_RENEW_DELEGATION_CB	0x02
54 
55 struct nfs_seqid_counter;
56 struct nfs4_minor_version_ops {
57 	u32	minor_version;
58 	unsigned init_caps;
59 
60 	int	(*init_client)(struct nfs_client *);
61 	void	(*shutdown_client)(struct nfs_client *);
62 	bool	(*match_stateid)(const nfs4_stateid *,
63 			const nfs4_stateid *);
64 	int	(*find_root_sec)(struct nfs_server *, struct nfs_fh *,
65 			struct nfs_fsinfo *);
66 	void	(*free_lock_state)(struct nfs_server *,
67 			struct nfs4_lock_state *);
68 	int	(*test_and_free_expired)(struct nfs_server *,
69 			nfs4_stateid *, const struct cred *);
70 	struct nfs_seqid *
71 		(*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
72 	void	(*session_trunk)(struct rpc_clnt *clnt,
73 			struct rpc_xprt *xprt, void *data);
74 	const struct rpc_call_ops *call_sync_ops;
75 	const struct nfs4_state_recovery_ops *reboot_recovery_ops;
76 	const struct nfs4_state_recovery_ops *nograce_recovery_ops;
77 	const struct nfs4_state_maintenance_ops *state_renewal_ops;
78 	const struct nfs4_mig_recovery_ops *mig_recovery_ops;
79 };
80 
81 #define NFS_SEQID_CONFIRMED 1
82 struct nfs_seqid_counter {
83 	ktime_t create_time;
84 	int owner_id;
85 	int flags;
86 	u32 counter;
87 	spinlock_t lock;		/* Protects the list */
88 	struct list_head list;		/* Defines sequence of RPC calls */
89 	struct rpc_wait_queue	wait;	/* RPC call delay queue */
90 };
91 
92 struct nfs_seqid {
93 	struct nfs_seqid_counter *sequence;
94 	struct list_head list;
95 	struct rpc_task *task;
96 };
97 
98 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
99 {
100 	if (seqid_mutating_err(-status))
101 		seqid->flags |= NFS_SEQID_CONFIRMED;
102 }
103 
104 /*
105  * NFS4 state_owners and lock_owners are simply labels for ordered
106  * sequences of RPC calls. Their sole purpose is to provide once-only
107  * semantics by allowing the server to identify replayed requests.
108  */
109 struct nfs4_state_owner {
110 	struct nfs_server    *so_server;
111 	struct list_head     so_lru;
112 	unsigned long        so_expires;
113 	struct rb_node	     so_server_node;
114 
115 	const struct cred    *so_cred;	 /* Associated cred */
116 
117 	spinlock_t	     so_lock;
118 	atomic_t	     so_count;
119 	unsigned long	     so_flags;
120 	struct list_head     so_states;
121 	struct nfs_seqid_counter so_seqid;
122 	seqcount_spinlock_t  so_reclaim_seqcount;
123 	struct mutex	     so_delegreturn_mutex;
124 };
125 
126 enum {
127 	NFS_OWNER_RECLAIM_REBOOT,
128 	NFS_OWNER_RECLAIM_NOGRACE
129 };
130 
131 #define NFS_LOCK_NEW		0
132 #define NFS_LOCK_RECLAIM	1
133 #define NFS_LOCK_EXPIRED	2
134 
135 /*
136  * struct nfs4_state maintains the client-side state for a given
137  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
138  *
139  * OPEN:
140  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
141  * we need to know how many files are open for reading or writing on a
142  * given inode. This information too is stored here.
143  *
144  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
145  */
146 
147 struct nfs4_lock_state {
148 	struct list_head	ls_locks;	/* Other lock stateids */
149 	struct nfs4_state *	ls_state;	/* Pointer to open state */
150 #define NFS_LOCK_INITIALIZED 0
151 #define NFS_LOCK_LOST        1
152 	unsigned long		ls_flags;
153 	struct nfs_seqid_counter	ls_seqid;
154 	nfs4_stateid		ls_stateid;
155 	refcount_t		ls_count;
156 	fl_owner_t		ls_owner;
157 };
158 
159 /* bits for nfs4_state->flags */
160 enum {
161 	LK_STATE_IN_USE,
162 	NFS_DELEGATED_STATE,		/* Current stateid is delegation */
163 	NFS_OPEN_STATE,			/* OPEN stateid is set */
164 	NFS_O_RDONLY_STATE,		/* OPEN stateid has read-only state */
165 	NFS_O_WRONLY_STATE,		/* OPEN stateid has write-only state */
166 	NFS_O_RDWR_STATE,		/* OPEN stateid has read/write state */
167 	NFS_STATE_RECLAIM_REBOOT,	/* OPEN stateid server rebooted */
168 	NFS_STATE_RECLAIM_NOGRACE,	/* OPEN stateid needs to recover state */
169 	NFS_STATE_POSIX_LOCKS,		/* Posix locks are supported */
170 	NFS_STATE_RECOVERY_FAILED,	/* OPEN stateid state recovery failed */
171 	NFS_STATE_MAY_NOTIFY_LOCK,	/* server may CB_NOTIFY_LOCK */
172 	NFS_STATE_CHANGE_WAIT,		/* A state changing operation is outstanding */
173 	NFS_CLNT_DST_SSC_COPY_STATE,    /* dst server open state on client*/
174 	NFS_CLNT_SRC_SSC_COPY_STATE,    /* src server open state on client*/
175 	NFS_SRV_SSC_COPY_STATE,		/* ssc state on the dst server */
176 };
177 
178 struct nfs4_state {
179 	struct list_head open_states;	/* List of states for the same state_owner */
180 	struct list_head inode_states;	/* List of states for the same inode */
181 	struct list_head lock_states;	/* List of subservient lock stateids */
182 
183 	struct nfs4_state_owner *owner;	/* Pointer to the open owner */
184 	struct inode *inode;		/* Pointer to the inode */
185 
186 	unsigned long flags;		/* Do we hold any locks? */
187 	spinlock_t state_lock;		/* Protects the lock_states list */
188 
189 	seqlock_t seqlock;		/* Protects the stateid/open_stateid */
190 	nfs4_stateid stateid;		/* Current stateid: may be delegation */
191 	nfs4_stateid open_stateid;	/* OPEN stateid */
192 
193 	/* The following 3 fields are protected by owner->so_lock */
194 	unsigned int n_rdonly;		/* Number of read-only references */
195 	unsigned int n_wronly;		/* Number of write-only references */
196 	unsigned int n_rdwr;		/* Number of read/write references */
197 	fmode_t state;			/* State on the server (R,W, or RW) */
198 	refcount_t count;
199 
200 	wait_queue_head_t waitq;
201 	struct rcu_head rcu_head;
202 };
203 
204 
205 struct nfs4_exception {
206 	struct nfs4_state *state;
207 	struct inode *inode;
208 	nfs4_stateid *stateid;
209 	long timeout;
210 	unsigned char task_is_privileged : 1;
211 	unsigned char delay : 1,
212 		      recovering : 1,
213 		      retry : 1;
214 	bool interruptible;
215 };
216 
217 struct nfs4_state_recovery_ops {
218 	int owner_flag_bit;
219 	int state_flag_bit;
220 	int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
221 	int (*recover_lock)(struct nfs4_state *, struct file_lock *);
222 	int (*establish_clid)(struct nfs_client *, const struct cred *);
223 	int (*reclaim_complete)(struct nfs_client *, const struct cred *);
224 	int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
225 		const struct cred *);
226 };
227 
228 struct nfs4_opendata {
229 	struct kref kref;
230 	struct nfs_openargs o_arg;
231 	struct nfs_openres o_res;
232 	struct nfs_open_confirmargs c_arg;
233 	struct nfs_open_confirmres c_res;
234 	struct nfs4_string owner_name;
235 	struct nfs4_string group_name;
236 	struct nfs4_label *a_label;
237 	struct nfs_fattr f_attr;
238 	struct dentry *dir;
239 	struct dentry *dentry;
240 	struct nfs4_state_owner *owner;
241 	struct nfs4_state *state;
242 	struct iattr attrs;
243 	struct nfs4_layoutget *lgp;
244 	unsigned long timestamp;
245 	bool rpc_done;
246 	bool file_created;
247 	bool is_recover;
248 	bool cancelled;
249 	int rpc_status;
250 };
251 
252 struct nfs4_add_xprt_data {
253 	struct nfs_client	*clp;
254 	const struct cred	*cred;
255 };
256 
257 struct nfs4_state_maintenance_ops {
258 	int (*sched_state_renewal)(struct nfs_client *, const struct cred *, unsigned);
259 	const struct cred * (*get_state_renewal_cred)(struct nfs_client *);
260 	int (*renew_lease)(struct nfs_client *, const struct cred *);
261 };
262 
263 struct nfs4_mig_recovery_ops {
264 	int (*get_locations)(struct nfs_server *, struct nfs_fh *,
265 		struct nfs4_fs_locations *, struct page *, const struct cred *);
266 	int (*fsid_present)(struct inode *, const struct cred *);
267 };
268 
269 extern const struct dentry_operations nfs4_dentry_operations;
270 
271 /* dir.c */
272 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
273 		    unsigned, umode_t);
274 
275 /* fs_context.c */
276 extern struct file_system_type nfs4_fs_type;
277 
278 /* nfs4namespace.c */
279 struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
280 					 const struct qstr *);
281 int nfs4_submount(struct fs_context *, struct nfs_server *);
282 int nfs4_replace_transport(struct nfs_server *server,
283 				const struct nfs4_fs_locations *locations);
284 size_t nfs_parse_server_name(char *string, size_t len, struct sockaddr *sa,
285 			     size_t salen, struct net *net, int port);
286 /* nfs4proc.c */
287 extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
288 extern int nfs4_async_handle_error(struct rpc_task *task,
289 				   struct nfs_server *server,
290 				   struct nfs4_state *state, long *timeout);
291 extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
292 			  struct rpc_message *, struct nfs4_sequence_args *,
293 			  struct nfs4_sequence_res *, int);
294 extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
295 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, const struct cred *, struct nfs4_setclientid_res *);
296 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, const struct cred *);
297 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
298 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, const struct cred *cred);
299 extern int nfs4_proc_exchange_id(struct nfs_client *clp, const struct cred *cred);
300 extern int nfs4_destroy_clientid(struct nfs_client *clp);
301 extern int nfs4_init_clientid(struct nfs_client *, const struct cred *);
302 extern int nfs41_init_clientid(struct nfs_client *, const struct cred *);
303 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
304 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
305 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
306 				  struct nfs4_fs_locations *, struct page *);
307 extern int nfs4_proc_get_locations(struct nfs_server *, struct nfs_fh *,
308 				   struct nfs4_fs_locations *,
309 				   struct page *page, const struct cred *);
310 extern int nfs4_proc_fsid_present(struct inode *, const struct cred *);
311 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *,
312 						    struct dentry *,
313 						    struct nfs_fh *,
314 						    struct nfs_fattr *);
315 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
316 extern const struct xattr_handler *nfs4_xattr_handlers[];
317 extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
318 		const struct nfs_open_context *ctx,
319 		const struct nfs_lock_context *l_ctx,
320 		fmode_t fmode);
321 extern void nfs4_bitmask_set(__u32 bitmask[], const __u32 src[],
322 			     struct inode *inode, unsigned long cache_validity);
323 extern int nfs4_proc_getattr(struct nfs_server *server, struct nfs_fh *fhandle,
324 			     struct nfs_fattr *fattr, struct inode *inode);
325 extern int update_open_stateid(struct nfs4_state *state,
326 				const nfs4_stateid *open_stateid,
327 				const nfs4_stateid *deleg_stateid,
328 				fmode_t fmode);
329 extern int nfs4_proc_setlease(struct file *file, long arg,
330 			      struct file_lock **lease, void **priv);
331 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
332 		struct nfs_fsinfo *fsinfo);
333 extern void nfs4_update_changeattr(struct inode *dir,
334 				   struct nfs4_change_info *cinfo,
335 				   unsigned long timestamp,
336 				   unsigned long cache_validity);
337 extern int nfs4_buf_to_pages_noslab(const void *buf, size_t buflen,
338 				    struct page **pages);
339 
340 #if defined(CONFIG_NFS_V4_1)
341 extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
342 extern int nfs4_proc_create_session(struct nfs_client *, const struct cred *);
343 extern int nfs4_proc_destroy_session(struct nfs4_session *, const struct cred *);
344 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
345 				  bool sync);
346 extern int nfs4_detect_session_trunking(struct nfs_client *clp,
347 		struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
348 
349 static inline bool
350 is_ds_only_client(struct nfs_client *clp)
351 {
352 	return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
353 		EXCHGID4_FLAG_USE_PNFS_DS;
354 }
355 
356 static inline bool
357 is_ds_client(struct nfs_client *clp)
358 {
359 	return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
360 }
361 
362 static inline bool
363 _nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
364 		    struct rpc_clnt **clntp, struct rpc_message *msg)
365 {
366 	rpc_authflavor_t flavor;
367 
368 	if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
369 	    sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
370 		/* Using machine creds for cleanup operations
371 		 * is only relevent if the client credentials
372 		 * might expire. So don't bother for
373 		 * RPC_AUTH_UNIX.  If file was only exported to
374 		 * sec=sys, the PUTFH would fail anyway.
375 		 */
376 		if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
377 			return false;
378 	}
379 	if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
380 		msg->rpc_cred = rpc_machine_cred();
381 
382 		flavor = clp->cl_rpcclient->cl_auth->au_flavor;
383 		WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
384 			     flavor != RPC_AUTH_GSS_KRB5P);
385 		*clntp = clp->cl_rpcclient;
386 
387 		return true;
388 	}
389 	return false;
390 }
391 
392 /*
393  * Function responsible for determining if an rpc_message should use the
394  * machine cred under SP4_MACH_CRED and if so switching the credential and
395  * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
396  * Should be called before rpc_call_sync/rpc_call_async.
397  */
398 static inline void
399 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
400 		   struct rpc_clnt **clntp, struct rpc_message *msg)
401 {
402 	_nfs4_state_protect(clp, sp4_mode, clntp, msg);
403 }
404 
405 /*
406  * Special wrapper to nfs4_state_protect for write.
407  * If WRITE can use machine cred but COMMIT cannot, make sure all writes
408  * that use machine cred use NFS_FILE_SYNC.
409  */
410 static inline void
411 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
412 			 struct rpc_message *msg, struct nfs_pgio_header *hdr)
413 {
414 	if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
415 	    !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
416 		hdr->args.stable = NFS_FILE_SYNC;
417 }
418 #else /* CONFIG_NFS_v4_1 */
419 static inline bool
420 is_ds_only_client(struct nfs_client *clp)
421 {
422 	return false;
423 }
424 
425 static inline bool
426 is_ds_client(struct nfs_client *clp)
427 {
428 	return false;
429 }
430 
431 static inline void
432 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
433 		   struct rpc_clnt **clntp, struct rpc_message *msg)
434 {
435 }
436 
437 static inline void
438 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
439 			 struct rpc_message *msg, struct nfs_pgio_header *hdr)
440 {
441 }
442 #endif /* CONFIG_NFS_V4_1 */
443 
444 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
445 
446 extern const u32 nfs4_fattr_bitmap[3];
447 extern const u32 nfs4_statfs_bitmap[3];
448 extern const u32 nfs4_pathconf_bitmap[3];
449 extern const u32 nfs4_fsinfo_bitmap[3];
450 extern const u32 nfs4_fs_locations_bitmap[3];
451 
452 void nfs40_shutdown_client(struct nfs_client *);
453 void nfs41_shutdown_client(struct nfs_client *);
454 int nfs40_init_client(struct nfs_client *);
455 int nfs41_init_client(struct nfs_client *);
456 void nfs4_free_client(struct nfs_client *);
457 
458 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
459 
460 /* nfs4renewd.c */
461 extern void nfs4_schedule_state_renewal(struct nfs_client *);
462 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
463 extern void nfs4_kill_renewd(struct nfs_client *);
464 extern void nfs4_renew_state(struct work_struct *);
465 extern void nfs4_set_lease_period(struct nfs_client *clp, unsigned long lease);
466 
467 
468 /* nfs4state.c */
469 extern const nfs4_stateid current_stateid;
470 
471 const struct cred *nfs4_get_clid_cred(struct nfs_client *clp);
472 const struct cred *nfs4_get_machine_cred(struct nfs_client *clp);
473 const struct cred *nfs4_get_renew_cred(struct nfs_client *clp);
474 int nfs4_discover_server_trunking(struct nfs_client *clp,
475 			struct nfs_client **);
476 int nfs40_discover_server_trunking(struct nfs_client *clp,
477 			struct nfs_client **, const struct cred *);
478 #if defined(CONFIG_NFS_V4_1)
479 int nfs41_discover_server_trunking(struct nfs_client *clp,
480 			struct nfs_client **, const struct cred *);
481 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
482 extern void nfs41_notify_server(struct nfs_client *);
483 bool nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
484 			struct nfs41_server_owner *o2);
485 #else
486 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
487 {
488 }
489 #endif /* CONFIG_NFS_V4_1 */
490 
491 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, const struct cred *, gfp_t);
492 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
493 extern void nfs4_purge_state_owners(struct nfs_server *, struct list_head *);
494 extern void nfs4_free_state_owners(struct list_head *head);
495 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
496 extern void nfs4_put_open_state(struct nfs4_state *);
497 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
498 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
499 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
500 extern void nfs_inode_find_state_and_recover(struct inode *inode,
501 		const nfs4_stateid *stateid);
502 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
503 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
504 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
505 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
506 extern void nfs4_schedule_state_manager(struct nfs_client *);
507 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
508 extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
509 extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
510 extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
511 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
512 extern void nfs41_handle_server_scope(struct nfs_client *,
513 				      struct nfs41_server_scope **);
514 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
515 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
516 extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
517 		const struct nfs_lock_context *, nfs4_stateid *,
518 		const struct cred **);
519 extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
520 		struct nfs4_state *state);
521 
522 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
523 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
524 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
525 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
526 extern void nfs_release_seqid(struct nfs_seqid *seqid);
527 extern void nfs_free_seqid(struct nfs_seqid *seqid);
528 extern int nfs4_setup_sequence(struct nfs_client *client,
529 				struct nfs4_sequence_args *args,
530 				struct nfs4_sequence_res *res,
531 				struct rpc_task *task);
532 extern int nfs4_sequence_done(struct rpc_task *task,
533 			      struct nfs4_sequence_res *res);
534 
535 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
536 extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
537 extern const nfs4_stateid zero_stateid;
538 extern const nfs4_stateid invalid_stateid;
539 
540 /* nfs4super.c */
541 struct nfs_mount_info;
542 extern struct nfs_subversion nfs_v4;
543 extern bool nfs4_disable_idmapping;
544 extern unsigned short max_session_slots;
545 extern unsigned short max_session_cb_slots;
546 extern unsigned short send_implementation_id;
547 extern bool recover_lost_locks;
548 
549 #define NFS4_CLIENT_ID_UNIQ_LEN		(64)
550 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
551 
552 extern int nfs4_try_get_tree(struct fs_context *);
553 extern int nfs4_get_referral_tree(struct fs_context *);
554 
555 /* nfs4sysctl.c */
556 #ifdef CONFIG_SYSCTL
557 int nfs4_register_sysctl(void);
558 void nfs4_unregister_sysctl(void);
559 #else
560 static inline int nfs4_register_sysctl(void)
561 {
562 	return 0;
563 }
564 
565 static inline void nfs4_unregister_sysctl(void)
566 {
567 }
568 #endif
569 
570 /* nfs4xdr.c */
571 extern const struct rpc_procinfo nfs4_procedures[];
572 
573 #ifdef CONFIG_NFS_V4_2
574 extern const u32 nfs42_maxsetxattr_overhead;
575 extern const u32 nfs42_maxgetxattr_overhead;
576 extern const u32 nfs42_maxlistxattrs_overhead;
577 #endif
578 
579 struct nfs4_mount_data;
580 
581 /* callback_xdr.c */
582 extern const struct svc_version nfs4_callback_version1;
583 extern const struct svc_version nfs4_callback_version4;
584 
585 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
586 {
587 	memcpy(dst->data, src->data, sizeof(dst->data));
588 	dst->type = src->type;
589 }
590 
591 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
592 {
593 	if (dst->type != src->type)
594 		return false;
595 	return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
596 }
597 
598 static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
599 {
600 	return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
601 }
602 
603 static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
604 {
605 	return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
606 }
607 
608 static inline bool nfs4_stateid_is_next(const nfs4_stateid *s1, const nfs4_stateid *s2)
609 {
610 	u32 seq1 = be32_to_cpu(s1->seqid);
611 	u32 seq2 = be32_to_cpu(s2->seqid);
612 
613 	return seq2 == seq1 + 1U || (seq2 == 1U && seq1 == 0xffffffffU);
614 }
615 
616 static inline bool nfs4_stateid_match_or_older(const nfs4_stateid *dst, const nfs4_stateid *src)
617 {
618 	return nfs4_stateid_match_other(dst, src) &&
619 		!(src->seqid && nfs4_stateid_is_newer(dst, src));
620 }
621 
622 static inline void nfs4_stateid_seqid_inc(nfs4_stateid *s1)
623 {
624 	u32 seqid = be32_to_cpu(s1->seqid);
625 
626 	if (++seqid == 0)
627 		++seqid;
628 	s1->seqid = cpu_to_be32(seqid);
629 }
630 
631 static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
632 {
633 	return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
634 }
635 
636 static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
637 		const nfs4_stateid *stateid)
638 {
639 	return test_bit(NFS_OPEN_STATE, &state->flags) &&
640 		nfs4_stateid_match_other(&state->open_stateid, stateid);
641 }
642 
643 /* nfs42xattr.c */
644 #ifdef CONFIG_NFS_V4_2
645 extern int __init nfs4_xattr_cache_init(void);
646 extern void nfs4_xattr_cache_exit(void);
647 extern void nfs4_xattr_cache_add(struct inode *inode, const char *name,
648 				 const char *buf, struct page **pages,
649 				 ssize_t buflen);
650 extern void nfs4_xattr_cache_remove(struct inode *inode, const char *name);
651 extern ssize_t nfs4_xattr_cache_get(struct inode *inode, const char *name,
652 				char *buf, ssize_t buflen);
653 extern void nfs4_xattr_cache_set_list(struct inode *inode, const char *buf,
654 				      ssize_t buflen);
655 extern ssize_t nfs4_xattr_cache_list(struct inode *inode, char *buf,
656 				     ssize_t buflen);
657 extern void nfs4_xattr_cache_zap(struct inode *inode);
658 #else
659 static inline void nfs4_xattr_cache_zap(struct inode *inode)
660 {
661 }
662 #endif /* CONFIG_NFS_V4_2 */
663 
664 #else /* CONFIG_NFS_V4 */
665 
666 #define nfs4_close_state(a, b) do { } while (0)
667 #define nfs4_close_sync(a, b) do { } while (0)
668 #define nfs4_state_protect(a, b, c, d) do { } while (0)
669 #define nfs4_state_protect_write(a, b, c, d) do { } while (0)
670 
671 
672 #endif /* CONFIG_NFS_V4 */
673 #endif /* __LINUX_FS_NFS_NFS4_FS.H */
674