xref: /kernel/linux/linux-5.10/fs/nfs/nfs4_fs.h (revision 8c2ecf20)
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
27struct idmap;
28
29enum 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
55struct nfs_seqid_counter;
56struct 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
82struct 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
92struct nfs_seqid {
93	struct nfs_seqid_counter *sequence;
94	struct list_head list;
95	struct rpc_task *task;
96};
97
98static 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 */
109struct 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
126enum {
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
147struct 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 */
160enum {
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
178struct 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
205struct 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
217struct 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
228struct 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 nfs4_label *f_label;
239	struct dentry *dir;
240	struct dentry *dentry;
241	struct nfs4_state_owner *owner;
242	struct nfs4_state *state;
243	struct iattr attrs;
244	struct nfs4_layoutget *lgp;
245	unsigned long timestamp;
246	bool rpc_done;
247	bool file_created;
248	bool is_recover;
249	bool cancelled;
250	int rpc_status;
251};
252
253struct nfs4_add_xprt_data {
254	struct nfs_client	*clp;
255	const struct cred	*cred;
256};
257
258struct nfs4_state_maintenance_ops {
259	int (*sched_state_renewal)(struct nfs_client *, const struct cred *, unsigned);
260	const struct cred * (*get_state_renewal_cred)(struct nfs_client *);
261	int (*renew_lease)(struct nfs_client *, const struct cred *);
262};
263
264struct nfs4_mig_recovery_ops {
265	int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
266		struct page *, const struct cred *);
267	int (*fsid_present)(struct inode *, const struct cred *);
268};
269
270extern const struct dentry_operations nfs4_dentry_operations;
271
272/* dir.c */
273int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
274		    unsigned, umode_t);
275
276/* fs_context.c */
277extern struct file_system_type nfs4_fs_type;
278
279/* nfs4namespace.c */
280struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
281					 const struct qstr *);
282int nfs4_submount(struct fs_context *, struct nfs_server *);
283int nfs4_replace_transport(struct nfs_server *server,
284				const struct nfs4_fs_locations *locations);
285size_t nfs_parse_server_name(char *string, size_t len, struct sockaddr *sa,
286			     size_t salen, struct net *net, int port);
287/* nfs4proc.c */
288extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
289extern int nfs4_async_handle_error(struct rpc_task *task,
290				   struct nfs_server *server,
291				   struct nfs4_state *state, long *timeout);
292extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
293			  struct rpc_message *, struct nfs4_sequence_args *,
294			  struct nfs4_sequence_res *, int);
295extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
296extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, const struct cred *, struct nfs4_setclientid_res *);
297extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, const struct cred *);
298extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
299extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, const struct cred *cred);
300extern int nfs4_proc_exchange_id(struct nfs_client *clp, const struct cred *cred);
301extern int nfs4_destroy_clientid(struct nfs_client *clp);
302extern int nfs4_init_clientid(struct nfs_client *, const struct cred *);
303extern int nfs41_init_clientid(struct nfs_client *, const struct cred *);
304extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
305extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
306extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
307				  struct nfs4_fs_locations *, struct page *);
308extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
309		struct page *page, const struct cred *);
310extern int nfs4_proc_fsid_present(struct inode *, const struct cred *);
311extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *,
312						    struct dentry *,
313						    struct nfs_fh *,
314						    struct nfs_fattr *);
315extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
316extern const struct xattr_handler *nfs4_xattr_handlers[];
317extern 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);
321extern int nfs4_proc_getattr(struct nfs_server *server, struct nfs_fh *fhandle,
322			     struct nfs_fattr *fattr, struct nfs4_label *label,
323			     struct inode *inode);
324extern int update_open_stateid(struct nfs4_state *state,
325				const nfs4_stateid *open_stateid,
326				const nfs4_stateid *deleg_stateid,
327				fmode_t fmode);
328
329extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
330		struct nfs_fsinfo *fsinfo);
331extern void nfs4_update_changeattr(struct inode *dir,
332				   struct nfs4_change_info *cinfo,
333				   unsigned long timestamp,
334				   unsigned long cache_validity);
335extern int nfs4_buf_to_pages_noslab(const void *buf, size_t buflen,
336				    struct page **pages);
337
338#if defined(CONFIG_NFS_V4_1)
339extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
340extern int nfs4_proc_create_session(struct nfs_client *, const struct cred *);
341extern int nfs4_proc_destroy_session(struct nfs4_session *, const struct cred *);
342extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
343				  bool sync);
344extern int nfs4_detect_session_trunking(struct nfs_client *clp,
345		struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
346
347static inline bool
348is_ds_only_client(struct nfs_client *clp)
349{
350	return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
351		EXCHGID4_FLAG_USE_PNFS_DS;
352}
353
354static inline bool
355is_ds_client(struct nfs_client *clp)
356{
357	return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
358}
359
360static inline bool
361_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
362		    struct rpc_clnt **clntp, struct rpc_message *msg)
363{
364	rpc_authflavor_t flavor;
365
366	if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
367	    sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
368		/* Using machine creds for cleanup operations
369		 * is only relevent if the client credentials
370		 * might expire. So don't bother for
371		 * RPC_AUTH_UNIX.  If file was only exported to
372		 * sec=sys, the PUTFH would fail anyway.
373		 */
374		if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
375			return false;
376	}
377	if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
378		msg->rpc_cred = rpc_machine_cred();
379
380		flavor = clp->cl_rpcclient->cl_auth->au_flavor;
381		WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
382			     flavor != RPC_AUTH_GSS_KRB5P);
383		*clntp = clp->cl_rpcclient;
384
385		return true;
386	}
387	return false;
388}
389
390/*
391 * Function responsible for determining if an rpc_message should use the
392 * machine cred under SP4_MACH_CRED and if so switching the credential and
393 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
394 * Should be called before rpc_call_sync/rpc_call_async.
395 */
396static inline void
397nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
398		   struct rpc_clnt **clntp, struct rpc_message *msg)
399{
400	_nfs4_state_protect(clp, sp4_mode, clntp, msg);
401}
402
403/*
404 * Special wrapper to nfs4_state_protect for write.
405 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
406 * that use machine cred use NFS_FILE_SYNC.
407 */
408static inline void
409nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
410			 struct rpc_message *msg, struct nfs_pgio_header *hdr)
411{
412	if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
413	    !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
414		hdr->args.stable = NFS_FILE_SYNC;
415}
416#else /* CONFIG_NFS_v4_1 */
417static inline bool
418is_ds_only_client(struct nfs_client *clp)
419{
420	return false;
421}
422
423static inline bool
424is_ds_client(struct nfs_client *clp)
425{
426	return false;
427}
428
429static inline void
430nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
431		   struct rpc_clnt **clntp, struct rpc_message *msg)
432{
433}
434
435static inline void
436nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
437			 struct rpc_message *msg, struct nfs_pgio_header *hdr)
438{
439}
440#endif /* CONFIG_NFS_V4_1 */
441
442extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
443
444extern const u32 nfs4_fattr_bitmap[3];
445extern const u32 nfs4_statfs_bitmap[3];
446extern const u32 nfs4_pathconf_bitmap[3];
447extern const u32 nfs4_fsinfo_bitmap[3];
448extern const u32 nfs4_fs_locations_bitmap[3];
449
450void nfs40_shutdown_client(struct nfs_client *);
451void nfs41_shutdown_client(struct nfs_client *);
452int nfs40_init_client(struct nfs_client *);
453int nfs41_init_client(struct nfs_client *);
454void nfs4_free_client(struct nfs_client *);
455
456struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
457
458/* nfs4renewd.c */
459extern void nfs4_schedule_state_renewal(struct nfs_client *);
460extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
461extern void nfs4_kill_renewd(struct nfs_client *);
462extern void nfs4_renew_state(struct work_struct *);
463extern void nfs4_set_lease_period(struct nfs_client *clp, unsigned long lease);
464
465
466/* nfs4state.c */
467extern const nfs4_stateid current_stateid;
468
469const struct cred *nfs4_get_clid_cred(struct nfs_client *clp);
470const struct cred *nfs4_get_machine_cred(struct nfs_client *clp);
471const struct cred *nfs4_get_renew_cred(struct nfs_client *clp);
472int nfs4_discover_server_trunking(struct nfs_client *clp,
473			struct nfs_client **);
474int nfs40_discover_server_trunking(struct nfs_client *clp,
475			struct nfs_client **, const struct cred *);
476#if defined(CONFIG_NFS_V4_1)
477int nfs41_discover_server_trunking(struct nfs_client *clp,
478			struct nfs_client **, const struct cred *);
479extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
480extern void nfs41_notify_server(struct nfs_client *);
481bool nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
482			struct nfs41_server_owner *o2);
483#else
484static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
485{
486}
487#endif /* CONFIG_NFS_V4_1 */
488
489extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, const struct cred *, gfp_t);
490extern void nfs4_put_state_owner(struct nfs4_state_owner *);
491extern void nfs4_purge_state_owners(struct nfs_server *, struct list_head *);
492extern void nfs4_free_state_owners(struct list_head *head);
493extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
494extern void nfs4_put_open_state(struct nfs4_state *);
495extern void nfs4_close_state(struct nfs4_state *, fmode_t);
496extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
497extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
498extern void nfs_inode_find_state_and_recover(struct inode *inode,
499		const nfs4_stateid *stateid);
500extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
501extern void nfs4_schedule_lease_recovery(struct nfs_client *);
502extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
503extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
504extern void nfs4_schedule_state_manager(struct nfs_client *);
505extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
506extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
507extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
508extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
509extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
510extern void nfs41_handle_server_scope(struct nfs_client *,
511				      struct nfs41_server_scope **);
512extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
513extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
514extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
515		const struct nfs_lock_context *, nfs4_stateid *,
516		const struct cred **);
517extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
518		struct nfs4_state *state);
519
520extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
521extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
522extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
523extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
524extern void nfs_release_seqid(struct nfs_seqid *seqid);
525extern void nfs_free_seqid(struct nfs_seqid *seqid);
526extern int nfs4_setup_sequence(struct nfs_client *client,
527				struct nfs4_sequence_args *args,
528				struct nfs4_sequence_res *res,
529				struct rpc_task *task);
530extern int nfs4_sequence_done(struct rpc_task *task,
531			      struct nfs4_sequence_res *res);
532
533extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
534extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
535extern const nfs4_stateid zero_stateid;
536extern const nfs4_stateid invalid_stateid;
537
538/* nfs4super.c */
539struct nfs_mount_info;
540extern struct nfs_subversion nfs_v4;
541extern bool nfs4_disable_idmapping;
542extern unsigned short max_session_slots;
543extern unsigned short max_session_cb_slots;
544extern unsigned short send_implementation_id;
545extern bool recover_lost_locks;
546
547#define NFS4_CLIENT_ID_UNIQ_LEN		(64)
548extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
549
550extern int nfs4_try_get_tree(struct fs_context *);
551extern int nfs4_get_referral_tree(struct fs_context *);
552
553/* nfs4sysctl.c */
554#ifdef CONFIG_SYSCTL
555int nfs4_register_sysctl(void);
556void nfs4_unregister_sysctl(void);
557#else
558static inline int nfs4_register_sysctl(void)
559{
560	return 0;
561}
562
563static inline void nfs4_unregister_sysctl(void)
564{
565}
566#endif
567
568/* nfs4xdr.c */
569extern const struct rpc_procinfo nfs4_procedures[];
570
571#ifdef CONFIG_NFS_V4_2
572extern const u32 nfs42_maxsetxattr_overhead;
573extern const u32 nfs42_maxgetxattr_overhead;
574extern const u32 nfs42_maxlistxattrs_overhead;
575#endif
576
577struct nfs4_mount_data;
578
579/* callback_xdr.c */
580extern const struct svc_version nfs4_callback_version1;
581extern const struct svc_version nfs4_callback_version4;
582
583static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
584{
585	memcpy(dst->data, src->data, sizeof(dst->data));
586	dst->type = src->type;
587}
588
589static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
590{
591	if (dst->type != src->type)
592		return false;
593	return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
594}
595
596static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
597{
598	return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
599}
600
601static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
602{
603	return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
604}
605
606static inline bool nfs4_stateid_is_next(const nfs4_stateid *s1, const nfs4_stateid *s2)
607{
608	u32 seq1 = be32_to_cpu(s1->seqid);
609	u32 seq2 = be32_to_cpu(s2->seqid);
610
611	return seq2 == seq1 + 1U || (seq2 == 1U && seq1 == 0xffffffffU);
612}
613
614static inline bool nfs4_stateid_match_or_older(const nfs4_stateid *dst, const nfs4_stateid *src)
615{
616	return nfs4_stateid_match_other(dst, src) &&
617		!(src->seqid && nfs4_stateid_is_newer(dst, src));
618}
619
620static inline void nfs4_stateid_seqid_inc(nfs4_stateid *s1)
621{
622	u32 seqid = be32_to_cpu(s1->seqid);
623
624	if (++seqid == 0)
625		++seqid;
626	s1->seqid = cpu_to_be32(seqid);
627}
628
629static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
630{
631	return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
632}
633
634static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
635		const nfs4_stateid *stateid)
636{
637	return test_bit(NFS_OPEN_STATE, &state->flags) &&
638		nfs4_stateid_match_other(&state->open_stateid, stateid);
639}
640
641/* nfs42xattr.c */
642#ifdef CONFIG_NFS_V4_2
643extern int __init nfs4_xattr_cache_init(void);
644extern void nfs4_xattr_cache_exit(void);
645extern void nfs4_xattr_cache_add(struct inode *inode, const char *name,
646				 const char *buf, struct page **pages,
647				 ssize_t buflen);
648extern void nfs4_xattr_cache_remove(struct inode *inode, const char *name);
649extern ssize_t nfs4_xattr_cache_get(struct inode *inode, const char *name,
650				char *buf, ssize_t buflen);
651extern void nfs4_xattr_cache_set_list(struct inode *inode, const char *buf,
652				      ssize_t buflen);
653extern ssize_t nfs4_xattr_cache_list(struct inode *inode, char *buf,
654				     ssize_t buflen);
655extern void nfs4_xattr_cache_zap(struct inode *inode);
656#else
657static inline void nfs4_xattr_cache_zap(struct inode *inode)
658{
659}
660#endif /* CONFIG_NFS_V4_2 */
661
662#else /* CONFIG_NFS_V4 */
663
664#define nfs4_close_state(a, b) do { } while (0)
665#define nfs4_close_sync(a, b) do { } while (0)
666#define nfs4_state_protect(a, b, c, d) do { } while (0)
667#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
668
669
670#endif /* CONFIG_NFS_V4 */
671#endif /* __LINUX_FS_NFS_NFS4_FS.H */
672