xref: /openbmc/linux/fs/nfs/nfs4_fs.h (revision 49a4bda2)
1 /*
2  * linux/fs/nfs/nfs4_fs.h
3  *
4  * Copyright (C) 2005 Trond Myklebust
5  *
6  * NFSv4-specific filesystem definitions and declarations
7  */
8 
9 #ifndef __LINUX_FS_NFS_NFS4_FS_H
10 #define __LINUX_FS_NFS_NFS4_FS_H
11 
12 #if defined(CONFIG_NFS_V4_2)
13 #define NFS4_MAX_MINOR_VERSION 2
14 #elif defined(CONFIG_NFS_V4_1)
15 #define NFS4_MAX_MINOR_VERSION 1
16 #else
17 #define NFS4_MAX_MINOR_VERSION 0
18 #endif
19 
20 #if IS_ENABLED(CONFIG_NFS_V4)
21 
22 #define NFS4_MAX_LOOP_ON_RECOVER (10)
23 
24 #include <linux/seqlock.h>
25 
26 struct idmap;
27 
28 enum nfs4_client_state {
29 	NFS4CLNT_MANAGER_RUNNING  = 0,
30 	NFS4CLNT_CHECK_LEASE,
31 	NFS4CLNT_LEASE_EXPIRED,
32 	NFS4CLNT_RECLAIM_REBOOT,
33 	NFS4CLNT_RECLAIM_NOGRACE,
34 	NFS4CLNT_DELEGRETURN,
35 	NFS4CLNT_SESSION_RESET,
36 	NFS4CLNT_LEASE_CONFIRM,
37 	NFS4CLNT_SERVER_SCOPE_MISMATCH,
38 	NFS4CLNT_PURGE_STATE,
39 	NFS4CLNT_BIND_CONN_TO_SESSION,
40 	NFS4CLNT_MOVED,
41 	NFS4CLNT_LEASE_MOVED,
42 };
43 
44 #define NFS4_RENEW_TIMEOUT		0x01
45 #define NFS4_RENEW_DELEGATION_CB	0x02
46 
47 struct nfs4_minor_version_ops {
48 	u32	minor_version;
49 	unsigned init_caps;
50 
51 	int	(*init_client)(struct nfs_client *);
52 	void	(*shutdown_client)(struct nfs_client *);
53 	bool	(*match_stateid)(const nfs4_stateid *,
54 			const nfs4_stateid *);
55 	int	(*find_root_sec)(struct nfs_server *, struct nfs_fh *,
56 			struct nfs_fsinfo *);
57 	int	(*free_lock_state)(struct nfs_server *,
58 			struct nfs4_lock_state *);
59 	const struct rpc_call_ops *call_sync_ops;
60 	const struct nfs4_state_recovery_ops *reboot_recovery_ops;
61 	const struct nfs4_state_recovery_ops *nograce_recovery_ops;
62 	const struct nfs4_state_maintenance_ops *state_renewal_ops;
63 	const struct nfs4_mig_recovery_ops *mig_recovery_ops;
64 };
65 
66 #define NFS_SEQID_CONFIRMED 1
67 struct nfs_seqid_counter {
68 	ktime_t create_time;
69 	int owner_id;
70 	int flags;
71 	u32 counter;
72 	spinlock_t lock;		/* Protects the list */
73 	struct list_head list;		/* Defines sequence of RPC calls */
74 	struct rpc_wait_queue	wait;	/* RPC call delay queue */
75 };
76 
77 struct nfs_seqid {
78 	struct nfs_seqid_counter *sequence;
79 	struct list_head list;
80 	struct rpc_task *task;
81 };
82 
83 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
84 {
85 	if (seqid_mutating_err(-status))
86 		seqid->flags |= NFS_SEQID_CONFIRMED;
87 }
88 
89 /*
90  * NFS4 state_owners and lock_owners are simply labels for ordered
91  * sequences of RPC calls. Their sole purpose is to provide once-only
92  * semantics by allowing the server to identify replayed requests.
93  */
94 struct nfs4_state_owner {
95 	struct nfs_server    *so_server;
96 	struct list_head     so_lru;
97 	unsigned long        so_expires;
98 	struct rb_node	     so_server_node;
99 
100 	struct rpc_cred	     *so_cred;	 /* Associated cred */
101 
102 	spinlock_t	     so_lock;
103 	atomic_t	     so_count;
104 	unsigned long	     so_flags;
105 	struct list_head     so_states;
106 	struct nfs_seqid_counter so_seqid;
107 	seqcount_t	     so_reclaim_seqcount;
108 	struct mutex	     so_delegreturn_mutex;
109 };
110 
111 enum {
112 	NFS_OWNER_RECLAIM_REBOOT,
113 	NFS_OWNER_RECLAIM_NOGRACE
114 };
115 
116 #define NFS_LOCK_NEW		0
117 #define NFS_LOCK_RECLAIM	1
118 #define NFS_LOCK_EXPIRED	2
119 
120 /*
121  * struct nfs4_state maintains the client-side state for a given
122  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
123  *
124  * OPEN:
125  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
126  * we need to know how many files are open for reading or writing on a
127  * given inode. This information too is stored here.
128  *
129  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
130  */
131 
132 struct nfs4_lock_state {
133 	struct list_head		ls_locks;   /* Other lock stateids */
134 	struct nfs4_state *		ls_state;   /* Pointer to open state */
135 #define NFS_LOCK_INITIALIZED 0
136 #define NFS_LOCK_LOST        1
137 	unsigned long			ls_flags;
138 	struct nfs_seqid_counter	ls_seqid;
139 	nfs4_stateid			ls_stateid;
140 	atomic_t			ls_count;
141 	fl_owner_t			ls_owner;
142 	struct work_struct		ls_release;
143 };
144 
145 /* bits for nfs4_state->flags */
146 enum {
147 	LK_STATE_IN_USE,
148 	NFS_DELEGATED_STATE,		/* Current stateid is delegation */
149 	NFS_OPEN_STATE,			/* OPEN stateid is set */
150 	NFS_O_RDONLY_STATE,		/* OPEN stateid has read-only state */
151 	NFS_O_WRONLY_STATE,		/* OPEN stateid has write-only state */
152 	NFS_O_RDWR_STATE,		/* OPEN stateid has read/write state */
153 	NFS_STATE_RECLAIM_REBOOT,	/* OPEN stateid server rebooted */
154 	NFS_STATE_RECLAIM_NOGRACE,	/* OPEN stateid needs to recover state */
155 	NFS_STATE_POSIX_LOCKS,		/* Posix locks are supported */
156 	NFS_STATE_RECOVERY_FAILED,	/* OPEN stateid state recovery failed */
157 };
158 
159 struct nfs4_state {
160 	struct list_head open_states;	/* List of states for the same state_owner */
161 	struct list_head inode_states;	/* List of states for the same inode */
162 	struct list_head lock_states;	/* List of subservient lock stateids */
163 
164 	struct nfs4_state_owner *owner;	/* Pointer to the open owner */
165 	struct inode *inode;		/* Pointer to the inode */
166 
167 	unsigned long flags;		/* Do we hold any locks? */
168 	spinlock_t state_lock;		/* Protects the lock_states list */
169 
170 	seqlock_t seqlock;		/* Protects the stateid/open_stateid */
171 	nfs4_stateid stateid;		/* Current stateid: may be delegation */
172 	nfs4_stateid open_stateid;	/* OPEN stateid */
173 
174 	/* The following 3 fields are protected by owner->so_lock */
175 	unsigned int n_rdonly;		/* Number of read-only references */
176 	unsigned int n_wronly;		/* Number of write-only references */
177 	unsigned int n_rdwr;		/* Number of read/write references */
178 	fmode_t state;			/* State on the server (R,W, or RW) */
179 	atomic_t count;
180 };
181 
182 
183 struct nfs4_exception {
184 	long timeout;
185 	int retry;
186 	struct nfs4_state *state;
187 	struct inode *inode;
188 };
189 
190 struct nfs4_state_recovery_ops {
191 	int owner_flag_bit;
192 	int state_flag_bit;
193 	int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
194 	int (*recover_lock)(struct nfs4_state *, struct file_lock *);
195 	int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
196 	int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
197 	int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
198 		struct rpc_cred *);
199 };
200 
201 struct nfs4_state_maintenance_ops {
202 	int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
203 	struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
204 	int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
205 };
206 
207 struct nfs4_mig_recovery_ops {
208 	int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
209 		struct page *, struct rpc_cred *);
210 	int (*fsid_present)(struct inode *, struct rpc_cred *);
211 };
212 
213 extern const struct dentry_operations nfs4_dentry_operations;
214 
215 /* dir.c */
216 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
217 		    unsigned, umode_t, int *);
218 
219 /* super.c */
220 extern struct file_system_type nfs4_fs_type;
221 
222 /* nfs4namespace.c */
223 struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *, struct qstr *);
224 struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
225 			       struct nfs_fh *, struct nfs_fattr *);
226 int nfs4_replace_transport(struct nfs_server *server,
227 				const struct nfs4_fs_locations *locations);
228 
229 /* nfs4proc.c */
230 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
231 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
232 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
233 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
234 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
235 extern int nfs4_destroy_clientid(struct nfs_client *clp);
236 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
237 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
238 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
239 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
240 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
241 				  struct nfs4_fs_locations *, struct page *);
242 extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
243 		struct page *page, struct rpc_cred *);
244 extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
245 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
246 			    struct nfs_fh *, struct nfs_fattr *);
247 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
248 extern const struct xattr_handler *nfs4_xattr_handlers[];
249 extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
250 		const struct nfs_open_context *ctx,
251 		const struct nfs_lock_context *l_ctx,
252 		fmode_t fmode);
253 
254 #if defined(CONFIG_NFS_V4_1)
255 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
256 {
257 	return server->nfs_client->cl_session;
258 }
259 
260 extern int nfs41_setup_sequence(struct nfs4_session *session,
261 		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
262 		struct rpc_task *task);
263 extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
264 extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
265 extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
266 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
267 		struct nfs_fsinfo *fsinfo);
268 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
269 				  bool sync);
270 
271 static inline bool
272 is_ds_only_client(struct nfs_client *clp)
273 {
274 	return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
275 		EXCHGID4_FLAG_USE_PNFS_DS;
276 }
277 
278 static inline bool
279 is_ds_client(struct nfs_client *clp)
280 {
281 	return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
282 }
283 
284 static inline bool
285 _nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
286 		    struct rpc_clnt **clntp, struct rpc_message *msg)
287 {
288 	struct rpc_cred *newcred = NULL;
289 	rpc_authflavor_t flavor;
290 
291 	if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
292 		spin_lock(&clp->cl_lock);
293 		if (clp->cl_machine_cred != NULL)
294 			/* don't call get_rpccred on the machine cred -
295 			 * a reference will be held for life of clp */
296 			newcred = clp->cl_machine_cred;
297 		spin_unlock(&clp->cl_lock);
298 		msg->rpc_cred = newcred;
299 
300 		flavor = clp->cl_rpcclient->cl_auth->au_flavor;
301 		WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
302 			     flavor != RPC_AUTH_GSS_KRB5P);
303 		*clntp = clp->cl_rpcclient;
304 
305 		return true;
306 	}
307 	return false;
308 }
309 
310 /*
311  * Function responsible for determining if an rpc_message should use the
312  * machine cred under SP4_MACH_CRED and if so switching the credential and
313  * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
314  * Should be called before rpc_call_sync/rpc_call_async.
315  */
316 static inline void
317 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
318 		   struct rpc_clnt **clntp, struct rpc_message *msg)
319 {
320 	_nfs4_state_protect(clp, sp4_mode, clntp, msg);
321 }
322 
323 /*
324  * Special wrapper to nfs4_state_protect for write.
325  * If WRITE can use machine cred but COMMIT cannot, make sure all writes
326  * that use machine cred use NFS_FILE_SYNC.
327  */
328 static inline void
329 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
330 			 struct rpc_message *msg, struct nfs_pgio_header *hdr)
331 {
332 	if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
333 	    !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
334 		hdr->args.stable = NFS_FILE_SYNC;
335 }
336 #else /* CONFIG_NFS_v4_1 */
337 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
338 {
339 	return NULL;
340 }
341 
342 static inline bool
343 is_ds_only_client(struct nfs_client *clp)
344 {
345 	return false;
346 }
347 
348 static inline bool
349 is_ds_client(struct nfs_client *clp)
350 {
351 	return false;
352 }
353 
354 static inline void
355 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
356 		   struct rpc_clnt **clntp, struct rpc_message *msg)
357 {
358 }
359 
360 static inline void
361 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
362 			 struct rpc_message *msg, struct nfs_pgio_header *hdr)
363 {
364 }
365 #endif /* CONFIG_NFS_V4_1 */
366 
367 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
368 
369 extern const u32 nfs4_fattr_bitmap[3];
370 extern const u32 nfs4_statfs_bitmap[3];
371 extern const u32 nfs4_pathconf_bitmap[3];
372 extern const u32 nfs4_fsinfo_bitmap[3];
373 extern const u32 nfs4_fs_locations_bitmap[3];
374 
375 void nfs40_shutdown_client(struct nfs_client *);
376 void nfs41_shutdown_client(struct nfs_client *);
377 int nfs40_init_client(struct nfs_client *);
378 int nfs41_init_client(struct nfs_client *);
379 void nfs4_free_client(struct nfs_client *);
380 
381 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
382 
383 /* nfs4renewd.c */
384 extern void nfs4_schedule_state_renewal(struct nfs_client *);
385 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
386 extern void nfs4_kill_renewd(struct nfs_client *);
387 extern void nfs4_renew_state(struct work_struct *);
388 
389 /* nfs4state.c */
390 struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
391 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
392 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
393 int nfs4_discover_server_trunking(struct nfs_client *clp,
394 			struct nfs_client **);
395 int nfs40_discover_server_trunking(struct nfs_client *clp,
396 			struct nfs_client **, struct rpc_cred *);
397 #if defined(CONFIG_NFS_V4_1)
398 int nfs41_discover_server_trunking(struct nfs_client *clp,
399 			struct nfs_client **, struct rpc_cred *);
400 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
401 extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
402 extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);
403 
404 #else
405 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
406 {
407 }
408 #endif /* CONFIG_NFS_V4_1 */
409 
410 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
411 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
412 extern void nfs4_purge_state_owners(struct nfs_server *);
413 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
414 extern void nfs4_put_open_state(struct nfs4_state *);
415 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
416 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
417 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
418 extern void nfs_inode_find_state_and_recover(struct inode *inode,
419 		const nfs4_stateid *stateid);
420 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
421 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
422 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
423 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
424 extern void nfs4_schedule_state_manager(struct nfs_client *);
425 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
426 extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
427 extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
428 extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
429 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
430 extern void nfs41_handle_server_scope(struct nfs_client *,
431 				      struct nfs41_server_scope **);
432 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
433 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
434 extern int nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
435 		fmode_t, const struct nfs_lockowner *);
436 
437 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
438 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
439 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
440 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
441 extern void nfs_release_seqid(struct nfs_seqid *seqid);
442 extern void nfs_free_seqid(struct nfs_seqid *seqid);
443 
444 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
445 
446 extern const nfs4_stateid zero_stateid;
447 
448 /* nfs4super.c */
449 struct nfs_mount_info;
450 extern struct nfs_subversion nfs_v4;
451 struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
452 extern bool nfs4_disable_idmapping;
453 extern unsigned short max_session_slots;
454 extern unsigned short send_implementation_id;
455 extern bool recover_lost_locks;
456 
457 #define NFS4_CLIENT_ID_UNIQ_LEN		(64)
458 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
459 
460 /* nfs4sysctl.c */
461 #ifdef CONFIG_SYSCTL
462 int nfs4_register_sysctl(void);
463 void nfs4_unregister_sysctl(void);
464 #else
465 static inline int nfs4_register_sysctl(void)
466 {
467 	return 0;
468 }
469 
470 static inline void nfs4_unregister_sysctl(void)
471 {
472 }
473 #endif
474 
475 /* nfs4xdr.c */
476 extern struct rpc_procinfo nfs4_procedures[];
477 
478 struct nfs4_mount_data;
479 
480 /* callback_xdr.c */
481 extern struct svc_version nfs4_callback_version1;
482 extern struct svc_version nfs4_callback_version4;
483 
484 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
485 {
486 	memcpy(dst, src, sizeof(*dst));
487 }
488 
489 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
490 {
491 	return memcmp(dst, src, sizeof(*dst)) == 0;
492 }
493 
494 static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
495 {
496 	return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
497 }
498 
499 static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
500 {
501 	return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
502 }
503 
504 static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
505 {
506 	return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
507 }
508 
509 #else
510 
511 #define nfs4_close_state(a, b) do { } while (0)
512 #define nfs4_close_sync(a, b) do { } while (0)
513 #define nfs4_state_protect(a, b, c, d) do { } while (0)
514 #define nfs4_state_protect_write(a, b, c, d) do { } while (0)
515 
516 #endif /* CONFIG_NFS_V4 */
517 #endif /* __LINUX_FS_NFS_NFS4_FS.H */
518