1
2
3
4
5
6
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
26struct idmap;
27
28enum 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
47struct nfs_seqid_counter;
48struct nfs4_minor_version_ops {
49 u32 minor_version;
50 unsigned init_caps;
51
52 int (*init_client)(struct nfs_client *);
53 void (*shutdown_client)(struct nfs_client *);
54 bool (*match_stateid)(const nfs4_stateid *,
55 const nfs4_stateid *);
56 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
57 struct nfs_fsinfo *);
58 void (*free_lock_state)(struct nfs_server *,
59 struct nfs4_lock_state *);
60 struct nfs_seqid *
61 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
62 const struct rpc_call_ops *call_sync_ops;
63 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
64 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
65 const struct nfs4_state_maintenance_ops *state_renewal_ops;
66 const struct nfs4_mig_recovery_ops *mig_recovery_ops;
67};
68
69#define NFS_SEQID_CONFIRMED 1
70struct nfs_seqid_counter {
71 ktime_t create_time;
72 int owner_id;
73 int flags;
74 u32 counter;
75 spinlock_t lock;
76 struct list_head list;
77 struct rpc_wait_queue wait;
78};
79
80struct nfs_seqid {
81 struct nfs_seqid_counter *sequence;
82 struct list_head list;
83 struct rpc_task *task;
84};
85
86static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
87{
88 if (seqid_mutating_err(-status))
89 seqid->flags |= NFS_SEQID_CONFIRMED;
90}
91
92
93
94
95
96
97struct nfs4_state_owner {
98 struct nfs_server *so_server;
99 struct list_head so_lru;
100 unsigned long so_expires;
101 struct rb_node so_server_node;
102
103 struct rpc_cred *so_cred;
104
105 spinlock_t so_lock;
106 atomic_t so_count;
107 unsigned long so_flags;
108 struct list_head so_states;
109 struct nfs_seqid_counter so_seqid;
110 seqcount_t so_reclaim_seqcount;
111 struct mutex so_delegreturn_mutex;
112};
113
114enum {
115 NFS_OWNER_RECLAIM_REBOOT,
116 NFS_OWNER_RECLAIM_NOGRACE
117};
118
119#define NFS_LOCK_NEW 0
120#define NFS_LOCK_RECLAIM 1
121#define NFS_LOCK_EXPIRED 2
122
123
124
125
126
127
128
129
130
131
132
133
134
135struct nfs4_lock_state {
136 struct list_head ls_locks;
137 struct nfs4_state * ls_state;
138#define NFS_LOCK_INITIALIZED 0
139#define NFS_LOCK_LOST 1
140 unsigned long ls_flags;
141 struct nfs_seqid_counter ls_seqid;
142 nfs4_stateid ls_stateid;
143 atomic_t ls_count;
144 fl_owner_t ls_owner;
145};
146
147
148enum {
149 LK_STATE_IN_USE,
150 NFS_DELEGATED_STATE,
151 NFS_OPEN_STATE,
152 NFS_O_RDONLY_STATE,
153 NFS_O_WRONLY_STATE,
154 NFS_O_RDWR_STATE,
155 NFS_STATE_RECLAIM_REBOOT,
156 NFS_STATE_RECLAIM_NOGRACE,
157 NFS_STATE_POSIX_LOCKS,
158 NFS_STATE_RECOVERY_FAILED,
159};
160
161struct nfs4_state {
162 struct list_head open_states;
163 struct list_head inode_states;
164 struct list_head lock_states;
165
166 struct nfs4_state_owner *owner;
167 struct inode *inode;
168
169 unsigned long flags;
170 spinlock_t state_lock;
171
172 seqlock_t seqlock;
173 nfs4_stateid stateid;
174 nfs4_stateid open_stateid;
175
176
177 unsigned int n_rdonly;
178 unsigned int n_wronly;
179 unsigned int n_rdwr;
180 fmode_t state;
181 atomic_t count;
182};
183
184
185struct nfs4_exception {
186 long timeout;
187 int retry;
188 struct nfs4_state *state;
189 struct inode *inode;
190};
191
192struct nfs4_state_recovery_ops {
193 int owner_flag_bit;
194 int state_flag_bit;
195 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
196 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
197 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
198 int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
199 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
200 struct rpc_cred *);
201};
202
203struct nfs4_state_maintenance_ops {
204 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
205 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
206 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
207};
208
209struct nfs4_mig_recovery_ops {
210 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
211 struct page *, struct rpc_cred *);
212 int (*fsid_present)(struct inode *, struct rpc_cred *);
213};
214
215extern const struct dentry_operations nfs4_dentry_operations;
216
217
218int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
219 unsigned, umode_t, int *);
220
221
222extern struct file_system_type nfs4_fs_type;
223
224
225struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *, struct qstr *);
226struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
227 struct nfs_fh *, struct nfs_fattr *);
228int nfs4_replace_transport(struct nfs_server *server,
229 const struct nfs4_fs_locations *locations);
230
231
232extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
233extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
234 struct rpc_message *, struct nfs4_sequence_args *,
235 struct nfs4_sequence_res *, int);
236extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int);
237extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
238extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
239extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
240extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
241extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
242extern int nfs4_destroy_clientid(struct nfs_client *clp);
243extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
244extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
245extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
246extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
247extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
248 struct nfs4_fs_locations *, struct page *);
249extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
250 struct page *page, struct rpc_cred *);
251extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
252extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
253 struct nfs_fh *, struct nfs_fattr *);
254extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
255extern const struct xattr_handler *nfs4_xattr_handlers[];
256extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
257 const struct nfs_open_context *ctx,
258 const struct nfs_lock_context *l_ctx,
259 fmode_t fmode);
260
261#if defined(CONFIG_NFS_V4_1)
262static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
263{
264 return server->nfs_client->cl_session;
265}
266
267extern int nfs41_setup_sequence(struct nfs4_session *session,
268 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
269 struct rpc_task *task);
270extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
271extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
272extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
273extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
274 struct nfs_fsinfo *fsinfo);
275extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
276 bool sync);
277
278static inline bool
279is_ds_only_client(struct nfs_client *clp)
280{
281 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
282 EXCHGID4_FLAG_USE_PNFS_DS;
283}
284
285static inline bool
286is_ds_client(struct nfs_client *clp)
287{
288 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
289}
290
291static inline bool
292_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
293 struct rpc_clnt **clntp, struct rpc_message *msg)
294{
295 struct rpc_cred *newcred = NULL;
296 rpc_authflavor_t flavor;
297
298 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
299 spin_lock(&clp->cl_lock);
300 if (clp->cl_machine_cred != NULL)
301
302
303 newcred = clp->cl_machine_cred;
304 spin_unlock(&clp->cl_lock);
305 msg->rpc_cred = newcred;
306
307 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
308 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
309 flavor != RPC_AUTH_GSS_KRB5P);
310 *clntp = clp->cl_rpcclient;
311
312 return true;
313 }
314 return false;
315}
316
317
318
319
320
321
322
323static inline void
324nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
325 struct rpc_clnt **clntp, struct rpc_message *msg)
326{
327 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
328}
329
330
331
332
333
334
335static inline void
336nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
337 struct rpc_message *msg, struct nfs_pgio_header *hdr)
338{
339 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
340 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
341 hdr->args.stable = NFS_FILE_SYNC;
342}
343#else
344static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
345{
346 return NULL;
347}
348
349static inline bool
350is_ds_only_client(struct nfs_client *clp)
351{
352 return false;
353}
354
355static inline bool
356is_ds_client(struct nfs_client *clp)
357{
358 return false;
359}
360
361static inline void
362nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
363 struct rpc_clnt **clntp, struct rpc_message *msg)
364{
365}
366
367static inline void
368nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
369 struct rpc_message *msg, struct nfs_pgio_header *hdr)
370{
371}
372#endif
373
374extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
375
376extern const u32 nfs4_fattr_bitmap[3];
377extern const u32 nfs4_statfs_bitmap[3];
378extern const u32 nfs4_pathconf_bitmap[3];
379extern const u32 nfs4_fsinfo_bitmap[3];
380extern const u32 nfs4_fs_locations_bitmap[3];
381
382void nfs40_shutdown_client(struct nfs_client *);
383void nfs41_shutdown_client(struct nfs_client *);
384int nfs40_init_client(struct nfs_client *);
385int nfs41_init_client(struct nfs_client *);
386void nfs4_free_client(struct nfs_client *);
387
388struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
389
390
391extern void nfs4_schedule_state_renewal(struct nfs_client *);
392extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
393extern void nfs4_kill_renewd(struct nfs_client *);
394extern void nfs4_renew_state(struct work_struct *);
395
396
397struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
398struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
399struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
400int nfs4_discover_server_trunking(struct nfs_client *clp,
401 struct nfs_client **);
402int nfs40_discover_server_trunking(struct nfs_client *clp,
403 struct nfs_client **, struct rpc_cred *);
404#if defined(CONFIG_NFS_V4_1)
405int nfs41_discover_server_trunking(struct nfs_client *clp,
406 struct nfs_client **, struct rpc_cred *);
407extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
408extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
409extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);
410
411#else
412static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
413{
414}
415#endif
416
417extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
418extern void nfs4_put_state_owner(struct nfs4_state_owner *);
419extern void nfs4_purge_state_owners(struct nfs_server *);
420extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
421extern void nfs4_put_open_state(struct nfs4_state *);
422extern void nfs4_close_state(struct nfs4_state *, fmode_t);
423extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
424extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
425extern void nfs_inode_find_state_and_recover(struct inode *inode,
426 const nfs4_stateid *stateid);
427extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
428extern void nfs4_schedule_lease_recovery(struct nfs_client *);
429extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
430extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
431extern void nfs4_schedule_state_manager(struct nfs_client *);
432extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
433extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
434extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
435extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
436extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
437extern void nfs41_handle_server_scope(struct nfs_client *,
438 struct nfs41_server_scope **);
439extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
440extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
441extern int nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
442 fmode_t, const struct nfs_lockowner *);
443
444extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
445extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
446extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
447extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
448extern void nfs_release_seqid(struct nfs_seqid *seqid);
449extern void nfs_free_seqid(struct nfs_seqid *seqid);
450extern int nfs40_setup_sequence(struct nfs4_slot_table *tbl,
451 struct nfs4_sequence_args *args,
452 struct nfs4_sequence_res *res,
453 struct rpc_task *task);
454extern int nfs4_sequence_done(struct rpc_task *task,
455 struct nfs4_sequence_res *res);
456
457extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
458
459extern const nfs4_stateid zero_stateid;
460
461
462struct nfs_mount_info;
463extern struct nfs_subversion nfs_v4;
464struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
465extern bool nfs4_disable_idmapping;
466extern unsigned short max_session_slots;
467extern unsigned short send_implementation_id;
468extern bool recover_lost_locks;
469
470#define NFS4_CLIENT_ID_UNIQ_LEN (64)
471extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
472
473
474#ifdef CONFIG_SYSCTL
475int nfs4_register_sysctl(void);
476void nfs4_unregister_sysctl(void);
477#else
478static inline int nfs4_register_sysctl(void)
479{
480 return 0;
481}
482
483static inline void nfs4_unregister_sysctl(void)
484{
485}
486#endif
487
488
489extern struct rpc_procinfo nfs4_procedures[];
490
491struct nfs4_mount_data;
492
493
494extern struct svc_version nfs4_callback_version1;
495extern struct svc_version nfs4_callback_version4;
496
497static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
498{
499 memcpy(dst, src, sizeof(*dst));
500}
501
502static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
503{
504 return memcmp(dst, src, sizeof(*dst)) == 0;
505}
506
507static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
508{
509 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
510}
511
512static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
513{
514 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
515}
516
517static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
518{
519 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
520}
521
522#else
523
524#define nfs4_close_state(a, b) do { } while (0)
525#define nfs4_close_sync(a, b) do { } while (0)
526#define nfs4_state_protect(a, b, c, d) do { } while (0)
527#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
528
529#endif
530#endif
531