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,
46 #define NFS4_RENEW_TIMEOUT 0x01
47 #define NFS4_RENEW_DELEGATION_CB 0x02
49 struct nfs_seqid_counter;
50 struct nfs4_minor_version_ops {
54 int (*init_client)(struct nfs_client *);
55 void (*shutdown_client)(struct nfs_client *);
56 bool (*match_stateid)(const nfs4_stateid *,
57 const nfs4_stateid *);
58 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
60 void (*free_lock_state)(struct nfs_server *,
61 struct nfs4_lock_state *);
62 int (*test_and_free_expired)(struct nfs_server *,
63 nfs4_stateid *, struct rpc_cred *);
65 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
66 int (*session_trunk)(struct rpc_clnt *, struct rpc_xprt *, void *);
67 const struct rpc_call_ops *call_sync_ops;
68 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
69 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
70 const struct nfs4_state_maintenance_ops *state_renewal_ops;
71 const struct nfs4_mig_recovery_ops *mig_recovery_ops;
74 #define NFS_SEQID_CONFIRMED 1
75 struct nfs_seqid_counter {
80 spinlock_t lock; /* Protects the list */
81 struct list_head list; /* Defines sequence of RPC calls */
82 struct rpc_wait_queue wait; /* RPC call delay queue */
86 struct nfs_seqid_counter *sequence;
87 struct list_head list;
88 struct rpc_task *task;
91 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
93 if (seqid_mutating_err(-status))
94 seqid->flags |= NFS_SEQID_CONFIRMED;
98 * NFS4 state_owners and lock_owners are simply labels for ordered
99 * sequences of RPC calls. Their sole purpose is to provide once-only
100 * semantics by allowing the server to identify replayed requests.
102 struct nfs4_state_owner {
103 struct nfs_server *so_server;
104 struct list_head so_lru;
105 unsigned long so_expires;
106 struct rb_node so_server_node;
108 struct rpc_cred *so_cred; /* Associated cred */
112 unsigned long so_flags;
113 struct list_head so_states;
114 struct nfs_seqid_counter so_seqid;
115 seqcount_t so_reclaim_seqcount;
116 struct mutex so_delegreturn_mutex;
120 NFS_OWNER_RECLAIM_REBOOT,
121 NFS_OWNER_RECLAIM_NOGRACE
124 #define NFS_LOCK_NEW 0
125 #define NFS_LOCK_RECLAIM 1
126 #define NFS_LOCK_EXPIRED 2
129 * struct nfs4_state maintains the client-side state for a given
130 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
133 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
134 * we need to know how many files are open for reading or writing on a
135 * given inode. This information too is stored here.
137 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
140 struct nfs4_lock_state {
141 struct list_head ls_locks; /* Other lock stateids */
142 struct nfs4_state * ls_state; /* Pointer to open state */
143 #define NFS_LOCK_INITIALIZED 0
144 #define NFS_LOCK_LOST 1
145 unsigned long ls_flags;
146 struct nfs_seqid_counter ls_seqid;
147 nfs4_stateid ls_stateid;
152 /* bits for nfs4_state->flags */
155 NFS_DELEGATED_STATE, /* Current stateid is delegation */
156 NFS_OPEN_STATE, /* OPEN stateid is set */
157 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
158 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
159 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
160 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
161 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
162 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
163 NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
164 NFS_STATE_MAY_NOTIFY_LOCK, /* server may CB_NOTIFY_LOCK */
165 NFS_STATE_CHANGE_WAIT, /* A state changing operation is outstanding */
166 #ifdef CONFIG_NFS_V4_2
167 NFS_CLNT_DST_SSC_COPY_STATE, /* dst server open state on client*/
168 #endif /* CONFIG_NFS_V4_2 */
172 struct list_head open_states; /* List of states for the same state_owner */
173 struct list_head inode_states; /* List of states for the same inode */
174 struct list_head lock_states; /* List of subservient lock stateids */
176 struct nfs4_state_owner *owner; /* Pointer to the open owner */
177 struct inode *inode; /* Pointer to the inode */
179 unsigned long flags; /* Do we hold any locks? */
180 spinlock_t state_lock; /* Protects the lock_states list */
182 seqlock_t seqlock; /* Protects the stateid/open_stateid */
183 nfs4_stateid stateid; /* Current stateid: may be delegation */
184 nfs4_stateid open_stateid; /* OPEN stateid */
186 /* The following 3 fields are protected by owner->so_lock */
187 unsigned int n_rdonly; /* Number of read-only references */
188 unsigned int n_wronly; /* Number of write-only references */
189 unsigned int n_rdwr; /* Number of read/write references */
190 fmode_t state; /* State on the server (R,W, or RW) */
193 wait_queue_head_t waitq;
194 struct rcu_head rcu_head;
198 struct nfs4_exception {
199 struct nfs4_state *state;
201 nfs4_stateid *stateid;
203 unsigned char delay : 1,
208 struct nfs4_state_recovery_ops {
211 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
212 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
213 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
214 int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
215 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
219 struct nfs4_opendata {
221 struct nfs_openargs o_arg;
222 struct nfs_openres o_res;
223 struct nfs_open_confirmargs c_arg;
224 struct nfs_open_confirmres c_res;
225 struct nfs4_string owner_name;
226 struct nfs4_string group_name;
227 struct nfs4_label *a_label;
228 struct nfs_fattr f_attr;
229 struct nfs4_label *f_label;
231 struct dentry *dentry;
232 struct nfs4_state_owner *owner;
233 struct nfs4_state *state;
235 struct nfs4_layoutget *lgp;
236 unsigned long timestamp;
244 struct nfs4_add_xprt_data {
245 struct nfs_client *clp;
246 struct rpc_cred *cred;
249 struct nfs4_state_maintenance_ops {
250 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
251 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
252 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
255 struct nfs4_mig_recovery_ops {
256 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
257 struct page *, struct rpc_cred *);
258 int (*fsid_present)(struct inode *, struct rpc_cred *);
261 extern const struct dentry_operations nfs4_dentry_operations;
264 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
268 extern struct file_system_type nfs4_fs_type;
270 /* nfs4namespace.c */
271 struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
272 const struct qstr *);
273 struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
274 struct nfs_fh *, struct nfs_fattr *);
275 int nfs4_replace_transport(struct nfs_server *server,
276 const struct nfs4_fs_locations *locations);
279 extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
280 extern int nfs4_async_handle_error(struct rpc_task *task,
281 struct nfs_server *server,
282 struct nfs4_state *state, long *timeout);
283 extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
284 struct rpc_message *, struct nfs4_sequence_args *,
285 struct nfs4_sequence_res *, int);
286 extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
287 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
288 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
289 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
290 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
291 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
292 extern int nfs4_destroy_clientid(struct nfs_client *clp);
293 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
294 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
295 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
296 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
297 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
298 struct nfs4_fs_locations *, struct page *);
299 extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
300 struct page *page, struct rpc_cred *);
301 extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
302 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
303 struct nfs_fh *, struct nfs_fattr *);
304 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
305 extern const struct xattr_handler *nfs4_xattr_handlers[];
306 extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
307 const struct nfs_open_context *ctx,
308 const struct nfs_lock_context *l_ctx,
311 #if defined(CONFIG_NFS_V4_1)
312 extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
313 extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
314 extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
315 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
316 struct nfs_fsinfo *fsinfo);
317 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
319 extern int nfs4_detect_session_trunking(struct nfs_client *clp,
320 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
323 is_ds_only_client(struct nfs_client *clp)
325 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
326 EXCHGID4_FLAG_USE_PNFS_DS;
330 is_ds_client(struct nfs_client *clp)
332 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
336 _nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
337 struct rpc_clnt **clntp, struct rpc_message *msg)
339 struct rpc_cred *newcred = NULL;
340 rpc_authflavor_t flavor;
342 if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
343 sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
344 /* Using machine creds for cleanup operations
345 * is only relevent if the client credentials
346 * might expire. So don't bother for
347 * RPC_AUTH_UNIX. If file was only exported to
348 * sec=sys, the PUTFH would fail anyway.
350 if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
353 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
354 spin_lock(&clp->cl_lock);
355 if (clp->cl_machine_cred != NULL)
356 /* don't call get_rpccred on the machine cred -
357 * a reference will be held for life of clp */
358 newcred = clp->cl_machine_cred;
359 spin_unlock(&clp->cl_lock);
360 msg->rpc_cred = newcred;
362 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
363 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
364 flavor != RPC_AUTH_GSS_KRB5P);
365 *clntp = clp->cl_rpcclient;
373 * Function responsible for determining if an rpc_message should use the
374 * machine cred under SP4_MACH_CRED and if so switching the credential and
375 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
376 * Should be called before rpc_call_sync/rpc_call_async.
379 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
380 struct rpc_clnt **clntp, struct rpc_message *msg)
382 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
386 * Special wrapper to nfs4_state_protect for write.
387 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
388 * that use machine cred use NFS_FILE_SYNC.
391 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
392 struct rpc_message *msg, struct nfs_pgio_header *hdr)
394 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
395 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
396 hdr->args.stable = NFS_FILE_SYNC;
398 #else /* CONFIG_NFS_v4_1 */
400 is_ds_only_client(struct nfs_client *clp)
406 is_ds_client(struct nfs_client *clp)
412 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
413 struct rpc_clnt **clntp, struct rpc_message *msg)
418 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
419 struct rpc_message *msg, struct nfs_pgio_header *hdr)
422 #endif /* CONFIG_NFS_V4_1 */
424 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
426 extern const u32 nfs4_fattr_bitmap[3];
427 extern const u32 nfs4_statfs_bitmap[3];
428 extern const u32 nfs4_pathconf_bitmap[3];
429 extern const u32 nfs4_fsinfo_bitmap[3];
430 extern const u32 nfs4_fs_locations_bitmap[3];
432 void nfs40_shutdown_client(struct nfs_client *);
433 void nfs41_shutdown_client(struct nfs_client *);
434 int nfs40_init_client(struct nfs_client *);
435 int nfs41_init_client(struct nfs_client *);
436 void nfs4_free_client(struct nfs_client *);
438 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
441 extern void nfs4_schedule_state_renewal(struct nfs_client *);
442 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
443 extern void nfs4_kill_renewd(struct nfs_client *);
444 extern void nfs4_renew_state(struct work_struct *);
445 extern void nfs4_set_lease_period(struct nfs_client *clp,
447 unsigned long lastrenewed);
451 struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
452 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
453 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
454 int nfs4_discover_server_trunking(struct nfs_client *clp,
455 struct nfs_client **);
456 int nfs40_discover_server_trunking(struct nfs_client *clp,
457 struct nfs_client **, struct rpc_cred *);
458 #if defined(CONFIG_NFS_V4_1)
459 int nfs41_discover_server_trunking(struct nfs_client *clp,
460 struct nfs_client **, struct rpc_cred *);
461 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
462 extern void nfs41_notify_server(struct nfs_client *);
464 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
467 #endif /* CONFIG_NFS_V4_1 */
469 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
470 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
471 extern void nfs4_purge_state_owners(struct nfs_server *);
472 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
473 extern void nfs4_put_open_state(struct nfs4_state *);
474 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
475 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
476 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
477 extern void nfs_inode_find_state_and_recover(struct inode *inode,
478 const nfs4_stateid *stateid);
479 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
480 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
481 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
482 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
483 extern void nfs4_schedule_state_manager(struct nfs_client *);
484 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
485 extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
486 extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
487 extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
488 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
489 extern void nfs41_handle_server_scope(struct nfs_client *,
490 struct nfs41_server_scope **);
491 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
492 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
493 extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
494 const struct nfs_lock_context *, nfs4_stateid *,
496 extern bool nfs4_refresh_open_stateid(nfs4_stateid *dst,
497 struct nfs4_state *state);
498 extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
499 struct nfs4_state *state);
501 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
502 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
503 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
504 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
505 extern void nfs_release_seqid(struct nfs_seqid *seqid);
506 extern void nfs_free_seqid(struct nfs_seqid *seqid);
507 extern int nfs4_setup_sequence(struct nfs_client *client,
508 struct nfs4_sequence_args *args,
509 struct nfs4_sequence_res *res,
510 struct rpc_task *task);
511 extern int nfs4_sequence_done(struct rpc_task *task,
512 struct nfs4_sequence_res *res);
514 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
515 extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
516 extern const nfs4_stateid zero_stateid;
517 extern const nfs4_stateid invalid_stateid;
520 struct nfs_mount_info;
521 extern struct nfs_subversion nfs_v4;
522 struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
523 extern bool nfs4_disable_idmapping;
524 extern unsigned short max_session_slots;
525 extern unsigned short max_session_cb_slots;
526 extern unsigned short send_implementation_id;
527 extern bool recover_lost_locks;
529 #define NFS4_CLIENT_ID_UNIQ_LEN (64)
530 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
534 int nfs4_register_sysctl(void);
535 void nfs4_unregister_sysctl(void);
537 static inline int nfs4_register_sysctl(void)
542 static inline void nfs4_unregister_sysctl(void)
548 extern const struct rpc_procinfo nfs4_procedures[];
550 struct nfs4_mount_data;
553 extern const struct svc_version nfs4_callback_version1;
554 extern const struct svc_version nfs4_callback_version4;
556 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
558 memcpy(dst->data, src->data, sizeof(dst->data));
559 dst->type = src->type;
562 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
564 if (dst->type != src->type)
566 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
569 static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
571 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
574 static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
576 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
579 static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
581 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
584 static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
585 const nfs4_stateid *stateid)
587 return test_bit(NFS_OPEN_STATE, &state->flags) &&
588 nfs4_stateid_match_other(&state->open_stateid, stateid);
593 #define nfs4_close_state(a, b) do { } while (0)
594 #define nfs4_close_sync(a, b) do { } while (0)
595 #define nfs4_state_protect(a, b, c, d) do { } while (0)
596 #define nfs4_state_protect_write(a, b, c, d) do { } while (0)
598 #endif /* CONFIG_NFS_V4 */
599 #endif /* __LINUX_FS_NFS_NFS4_FS.H */