1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/fs/nfs/nfs4_fs.h
5 * Copyright (C) 2005 Trond Myklebust
7 * NFSv4-specific filesystem definitions and declarations
10 #ifndef __LINUX_FS_NFS_NFS4_FS_H
11 #define __LINUX_FS_NFS_NFS4_FS_H
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
18 #define NFS4_MAX_MINOR_VERSION 0
21 #if IS_ENABLED(CONFIG_NFS_V4)
23 #define NFS4_MAX_LOOP_ON_RECOVER (10)
25 #include <linux/seqlock.h>
29 enum nfs4_client_state {
30 NFS4CLNT_MANAGER_RUNNING = 0,
32 NFS4CLNT_LEASE_EXPIRED,
33 NFS4CLNT_RECLAIM_REBOOT,
34 NFS4CLNT_RECLAIM_NOGRACE,
36 NFS4CLNT_SESSION_RESET,
37 NFS4CLNT_LEASE_CONFIRM,
38 NFS4CLNT_SERVER_SCOPE_MISMATCH,
40 NFS4CLNT_BIND_CONN_TO_SESSION,
43 NFS4CLNT_DELEGATION_EXPIRED,
45 NFS4CLNT_DELEGRETURN_RUNNING,
48 #define NFS4_RENEW_TIMEOUT 0x01
49 #define NFS4_RENEW_DELEGATION_CB 0x02
51 struct nfs_seqid_counter;
52 struct nfs4_minor_version_ops {
56 int (*init_client)(struct nfs_client *);
57 void (*shutdown_client)(struct nfs_client *);
58 bool (*match_stateid)(const nfs4_stateid *,
59 const nfs4_stateid *);
60 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
62 void (*free_lock_state)(struct nfs_server *,
63 struct nfs4_lock_state *);
64 int (*test_and_free_expired)(struct nfs_server *,
65 nfs4_stateid *, const struct cred *);
67 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
68 void (*session_trunk)(struct rpc_clnt *clnt,
69 struct rpc_xprt *xprt, void *data);
70 const struct rpc_call_ops *call_sync_ops;
71 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
72 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
73 const struct nfs4_state_maintenance_ops *state_renewal_ops;
74 const struct nfs4_mig_recovery_ops *mig_recovery_ops;
77 #define NFS_SEQID_CONFIRMED 1
78 struct nfs_seqid_counter {
83 spinlock_t lock; /* Protects the list */
84 struct list_head list; /* Defines sequence of RPC calls */
85 struct rpc_wait_queue wait; /* RPC call delay queue */
89 struct nfs_seqid_counter *sequence;
90 struct list_head list;
91 struct rpc_task *task;
94 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
96 if (seqid_mutating_err(-status))
97 seqid->flags |= NFS_SEQID_CONFIRMED;
101 * NFS4 state_owners and lock_owners are simply labels for ordered
102 * sequences of RPC calls. Their sole purpose is to provide once-only
103 * semantics by allowing the server to identify replayed requests.
105 struct nfs4_state_owner {
106 struct nfs_server *so_server;
107 struct list_head so_lru;
108 unsigned long so_expires;
109 struct rb_node so_server_node;
111 const struct cred *so_cred; /* Associated cred */
115 unsigned long so_flags;
116 struct list_head so_states;
117 struct nfs_seqid_counter so_seqid;
118 seqcount_t so_reclaim_seqcount;
119 struct mutex so_delegreturn_mutex;
123 NFS_OWNER_RECLAIM_REBOOT,
124 NFS_OWNER_RECLAIM_NOGRACE
127 #define NFS_LOCK_NEW 0
128 #define NFS_LOCK_RECLAIM 1
129 #define NFS_LOCK_EXPIRED 2
132 * struct nfs4_state maintains the client-side state for a given
133 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
136 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
137 * we need to know how many files are open for reading or writing on a
138 * given inode. This information too is stored here.
140 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
143 struct nfs4_lock_state {
144 struct list_head ls_locks; /* Other lock stateids */
145 struct nfs4_state * ls_state; /* Pointer to open state */
146 #define NFS_LOCK_INITIALIZED 0
147 #define NFS_LOCK_LOST 1
148 unsigned long ls_flags;
149 struct nfs_seqid_counter ls_seqid;
150 nfs4_stateid ls_stateid;
155 /* bits for nfs4_state->flags */
158 NFS_DELEGATED_STATE, /* Current stateid is delegation */
159 NFS_OPEN_STATE, /* OPEN stateid is set */
160 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
161 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
162 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
163 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
164 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
165 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
166 NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
167 NFS_STATE_MAY_NOTIFY_LOCK, /* server may CB_NOTIFY_LOCK */
168 NFS_STATE_CHANGE_WAIT, /* A state changing operation is outstanding */
169 #ifdef CONFIG_NFS_V4_2
170 NFS_CLNT_DST_SSC_COPY_STATE, /* dst server open state on client*/
171 #endif /* CONFIG_NFS_V4_2 */
175 struct list_head open_states; /* List of states for the same state_owner */
176 struct list_head inode_states; /* List of states for the same inode */
177 struct list_head lock_states; /* List of subservient lock stateids */
179 struct nfs4_state_owner *owner; /* Pointer to the open owner */
180 struct inode *inode; /* Pointer to the inode */
182 unsigned long flags; /* Do we hold any locks? */
183 spinlock_t state_lock; /* Protects the lock_states list */
185 seqlock_t seqlock; /* Protects the stateid/open_stateid */
186 nfs4_stateid stateid; /* Current stateid: may be delegation */
187 nfs4_stateid open_stateid; /* OPEN stateid */
189 /* The following 3 fields are protected by owner->so_lock */
190 unsigned int n_rdonly; /* Number of read-only references */
191 unsigned int n_wronly; /* Number of write-only references */
192 unsigned int n_rdwr; /* Number of read/write references */
193 fmode_t state; /* State on the server (R,W, or RW) */
196 wait_queue_head_t waitq;
197 struct rcu_head rcu_head;
201 struct nfs4_exception {
202 struct nfs4_state *state;
204 nfs4_stateid *stateid;
206 unsigned char delay : 1,
212 struct nfs4_state_recovery_ops {
215 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
216 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
217 int (*establish_clid)(struct nfs_client *, const struct cred *);
218 int (*reclaim_complete)(struct nfs_client *, const struct cred *);
219 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
220 const struct cred *);
223 struct nfs4_opendata {
225 struct nfs_openargs o_arg;
226 struct nfs_openres o_res;
227 struct nfs_open_confirmargs c_arg;
228 struct nfs_open_confirmres c_res;
229 struct nfs4_string owner_name;
230 struct nfs4_string group_name;
231 struct nfs4_label *a_label;
232 struct nfs_fattr f_attr;
233 struct nfs4_label *f_label;
235 struct dentry *dentry;
236 struct nfs4_state_owner *owner;
237 struct nfs4_state *state;
239 struct nfs4_layoutget *lgp;
240 unsigned long timestamp;
248 struct nfs4_add_xprt_data {
249 struct nfs_client *clp;
250 const struct cred *cred;
253 struct nfs4_state_maintenance_ops {
254 int (*sched_state_renewal)(struct nfs_client *, const struct cred *, unsigned);
255 const struct cred * (*get_state_renewal_cred)(struct nfs_client *);
256 int (*renew_lease)(struct nfs_client *, const struct cred *);
259 struct nfs4_mig_recovery_ops {
260 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
261 struct page *, const struct cred *);
262 int (*fsid_present)(struct inode *, const struct cred *);
265 extern const struct dentry_operations nfs4_dentry_operations;
268 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
272 extern struct file_system_type nfs4_fs_type;
274 /* nfs4namespace.c */
275 struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
276 const struct qstr *);
277 struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
278 struct nfs_fh *, struct nfs_fattr *);
279 int nfs4_replace_transport(struct nfs_server *server,
280 const struct nfs4_fs_locations *locations);
283 extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
284 extern int nfs4_async_handle_error(struct rpc_task *task,
285 struct nfs_server *server,
286 struct nfs4_state *state, long *timeout);
287 extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
288 struct rpc_message *, struct nfs4_sequence_args *,
289 struct nfs4_sequence_res *, int);
290 extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
291 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, const struct cred *, struct nfs4_setclientid_res *);
292 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, const struct cred *);
293 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
294 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, const struct cred *cred);
295 extern int nfs4_proc_exchange_id(struct nfs_client *clp, const struct cred *cred);
296 extern int nfs4_destroy_clientid(struct nfs_client *clp);
297 extern int nfs4_init_clientid(struct nfs_client *, const struct cred *);
298 extern int nfs41_init_clientid(struct nfs_client *, const struct cred *);
299 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
300 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
301 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
302 struct nfs4_fs_locations *, struct page *);
303 extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
304 struct page *page, const struct cred *);
305 extern int nfs4_proc_fsid_present(struct inode *, const struct cred *);
306 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
307 struct nfs_fh *, struct nfs_fattr *);
308 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
309 extern const struct xattr_handler *nfs4_xattr_handlers[];
310 extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
311 const struct nfs_open_context *ctx,
312 const struct nfs_lock_context *l_ctx,
315 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
316 struct nfs_fsinfo *fsinfo);
317 #if defined(CONFIG_NFS_V4_1)
318 extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
319 extern int nfs4_proc_create_session(struct nfs_client *, const struct cred *);
320 extern int nfs4_proc_destroy_session(struct nfs4_session *, const struct cred *);
321 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
323 extern int nfs4_detect_session_trunking(struct nfs_client *clp,
324 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
327 is_ds_only_client(struct nfs_client *clp)
329 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
330 EXCHGID4_FLAG_USE_PNFS_DS;
334 is_ds_client(struct nfs_client *clp)
336 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
340 _nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
341 struct rpc_clnt **clntp, struct rpc_message *msg)
343 rpc_authflavor_t flavor;
345 if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
346 sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
347 /* Using machine creds for cleanup operations
348 * is only relevent if the client credentials
349 * might expire. So don't bother for
350 * RPC_AUTH_UNIX. If file was only exported to
351 * sec=sys, the PUTFH would fail anyway.
353 if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
356 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
357 msg->rpc_cred = rpc_machine_cred();
359 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
360 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
361 flavor != RPC_AUTH_GSS_KRB5P);
362 *clntp = clp->cl_rpcclient;
370 * Function responsible for determining if an rpc_message should use the
371 * machine cred under SP4_MACH_CRED and if so switching the credential and
372 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
373 * Should be called before rpc_call_sync/rpc_call_async.
376 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
377 struct rpc_clnt **clntp, struct rpc_message *msg)
379 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
383 * Special wrapper to nfs4_state_protect for write.
384 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
385 * that use machine cred use NFS_FILE_SYNC.
388 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
389 struct rpc_message *msg, struct nfs_pgio_header *hdr)
391 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
392 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
393 hdr->args.stable = NFS_FILE_SYNC;
395 #else /* CONFIG_NFS_v4_1 */
397 is_ds_only_client(struct nfs_client *clp)
403 is_ds_client(struct nfs_client *clp)
409 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
410 struct rpc_clnt **clntp, struct rpc_message *msg)
415 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
416 struct rpc_message *msg, struct nfs_pgio_header *hdr)
419 #endif /* CONFIG_NFS_V4_1 */
421 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
423 extern const u32 nfs4_fattr_bitmap[3];
424 extern const u32 nfs4_statfs_bitmap[3];
425 extern const u32 nfs4_pathconf_bitmap[3];
426 extern const u32 nfs4_fsinfo_bitmap[3];
427 extern const u32 nfs4_fs_locations_bitmap[3];
429 void nfs40_shutdown_client(struct nfs_client *);
430 void nfs41_shutdown_client(struct nfs_client *);
431 int nfs40_init_client(struct nfs_client *);
432 int nfs41_init_client(struct nfs_client *);
433 void nfs4_free_client(struct nfs_client *);
435 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
438 extern void nfs4_schedule_state_renewal(struct nfs_client *);
439 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
440 extern void nfs4_kill_renewd(struct nfs_client *);
441 extern void nfs4_renew_state(struct work_struct *);
442 extern void nfs4_set_lease_period(struct nfs_client *clp,
444 unsigned long lastrenewed);
448 const struct cred *nfs4_get_clid_cred(struct nfs_client *clp);
449 const struct cred *nfs4_get_machine_cred(struct nfs_client *clp);
450 const struct cred *nfs4_get_renew_cred(struct nfs_client *clp);
451 int nfs4_discover_server_trunking(struct nfs_client *clp,
452 struct nfs_client **);
453 int nfs40_discover_server_trunking(struct nfs_client *clp,
454 struct nfs_client **, const struct cred *);
455 #if defined(CONFIG_NFS_V4_1)
456 int nfs41_discover_server_trunking(struct nfs_client *clp,
457 struct nfs_client **, const struct cred *);
458 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
459 extern void nfs41_notify_server(struct nfs_client *);
461 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
464 #endif /* CONFIG_NFS_V4_1 */
466 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, const struct cred *, gfp_t);
467 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
468 extern void nfs4_purge_state_owners(struct nfs_server *, struct list_head *);
469 extern void nfs4_free_state_owners(struct list_head *head);
470 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
471 extern void nfs4_put_open_state(struct nfs4_state *);
472 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
473 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
474 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
475 extern void nfs_inode_find_state_and_recover(struct inode *inode,
476 const nfs4_stateid *stateid);
477 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
478 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
479 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
480 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
481 extern void nfs4_schedule_state_manager(struct nfs_client *);
482 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
483 extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
484 extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
485 extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
486 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
487 extern void nfs41_handle_server_scope(struct nfs_client *,
488 struct nfs41_server_scope **);
489 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
490 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
491 extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
492 const struct nfs_lock_context *, nfs4_stateid *,
493 const struct cred **);
494 extern bool nfs4_refresh_open_stateid(nfs4_stateid *dst,
495 struct nfs4_state *state);
496 extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
497 struct nfs4_state *state);
499 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
500 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
501 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
502 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
503 extern void nfs_release_seqid(struct nfs_seqid *seqid);
504 extern void nfs_free_seqid(struct nfs_seqid *seqid);
505 extern int nfs4_setup_sequence(struct nfs_client *client,
506 struct nfs4_sequence_args *args,
507 struct nfs4_sequence_res *res,
508 struct rpc_task *task);
509 extern int nfs4_sequence_done(struct rpc_task *task,
510 struct nfs4_sequence_res *res);
512 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
513 extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
514 extern const nfs4_stateid zero_stateid;
515 extern const nfs4_stateid invalid_stateid;
518 struct nfs_mount_info;
519 extern struct nfs_subversion nfs_v4;
520 struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
521 extern bool nfs4_disable_idmapping;
522 extern unsigned short max_session_slots;
523 extern unsigned short max_session_cb_slots;
524 extern unsigned short send_implementation_id;
525 extern bool recover_lost_locks;
527 #define NFS4_CLIENT_ID_UNIQ_LEN (64)
528 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
532 int nfs4_register_sysctl(void);
533 void nfs4_unregister_sysctl(void);
535 static inline int nfs4_register_sysctl(void)
540 static inline void nfs4_unregister_sysctl(void)
546 extern const struct rpc_procinfo nfs4_procedures[];
548 struct nfs4_mount_data;
551 extern const struct svc_version nfs4_callback_version1;
552 extern const struct svc_version nfs4_callback_version4;
554 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
556 memcpy(dst->data, src->data, sizeof(dst->data));
557 dst->type = src->type;
560 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
562 if (dst->type != src->type)
564 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
567 static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
569 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
572 static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
574 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
577 static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
579 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
582 static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
583 const nfs4_stateid *stateid)
585 return test_bit(NFS_OPEN_STATE, &state->flags) &&
586 nfs4_stateid_match_other(&state->open_stateid, stateid);
591 #define nfs4_close_state(a, b) do { } while (0)
592 #define nfs4_close_sync(a, b) do { } while (0)
593 #define nfs4_state_protect(a, b, c, d) do { } while (0)
594 #define nfs4_state_protect_write(a, b, c, d) do { } while (0)
596 #endif /* CONFIG_NFS_V4 */
597 #endif /* __LINUX_FS_NFS_NFS4_FS.H */