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