1
2
3
4
5
6
7
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 NFS4CLNT_RUN_MANAGER,
45 NFS4CLNT_DELEGRETURN_RUNNING,
46};
47
48#define NFS4_RENEW_TIMEOUT 0x01
49#define NFS4_RENEW_DELEGATION_CB 0x02
50
51struct nfs_seqid_counter;
52struct nfs4_minor_version_ops {
53 u32 minor_version;
54 unsigned init_caps;
55
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 *,
61 struct nfs_fsinfo *);
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 *);
66 struct nfs_seqid *
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;
75};
76
77#define NFS_SEQID_CONFIRMED 1
78struct nfs_seqid_counter {
79 ktime_t create_time;
80 int owner_id;
81 int flags;
82 u32 counter;
83 spinlock_t lock;
84 struct list_head list;
85 struct rpc_wait_queue wait;
86};
87
88struct nfs_seqid {
89 struct nfs_seqid_counter *sequence;
90 struct list_head list;
91 struct rpc_task *task;
92};
93
94static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
95{
96 if (seqid_mutating_err(-status))
97 seqid->flags |= NFS_SEQID_CONFIRMED;
98}
99
100
101
102
103
104
105struct 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;
110
111 const struct cred *so_cred;
112
113 spinlock_t so_lock;
114 atomic_t so_count;
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;
120};
121
122enum {
123 NFS_OWNER_RECLAIM_REBOOT,
124 NFS_OWNER_RECLAIM_NOGRACE
125};
126
127#define NFS_LOCK_NEW 0
128#define NFS_LOCK_RECLAIM 1
129#define NFS_LOCK_EXPIRED 2
130
131
132
133
134
135
136
137
138
139
140
141
142
143struct nfs4_lock_state {
144 struct list_head ls_locks;
145 struct nfs4_state * ls_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;
151 refcount_t ls_count;
152 fl_owner_t ls_owner;
153};
154
155
156enum {
157 LK_STATE_IN_USE,
158 NFS_DELEGATED_STATE,
159 NFS_OPEN_STATE,
160 NFS_O_RDONLY_STATE,
161 NFS_O_WRONLY_STATE,
162 NFS_O_RDWR_STATE,
163 NFS_STATE_RECLAIM_REBOOT,
164 NFS_STATE_RECLAIM_NOGRACE,
165 NFS_STATE_POSIX_LOCKS,
166 NFS_STATE_RECOVERY_FAILED,
167 NFS_STATE_MAY_NOTIFY_LOCK,
168 NFS_STATE_CHANGE_WAIT,
169#ifdef CONFIG_NFS_V4_2
170 NFS_CLNT_DST_SSC_COPY_STATE,
171#endif
172};
173
174struct nfs4_state {
175 struct list_head open_states;
176 struct list_head inode_states;
177 struct list_head lock_states;
178
179 struct nfs4_state_owner *owner;
180 struct inode *inode;
181
182 unsigned long flags;
183 spinlock_t state_lock;
184
185 seqlock_t seqlock;
186 nfs4_stateid stateid;
187 nfs4_stateid open_stateid;
188
189
190 unsigned int n_rdonly;
191 unsigned int n_wronly;
192 unsigned int n_rdwr;
193 fmode_t state;
194 refcount_t count;
195
196 wait_queue_head_t waitq;
197 struct rcu_head rcu_head;
198};
199
200
201struct nfs4_exception {
202 struct nfs4_state *state;
203 struct inode *inode;
204 nfs4_stateid *stateid;
205 long timeout;
206 unsigned char delay : 1,
207 recovering : 1,
208 retry : 1;
209 bool interruptible;
210};
211
212struct nfs4_state_recovery_ops {
213 int owner_flag_bit;
214 int state_flag_bit;
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 *);
221};
222
223struct nfs4_opendata {
224 struct kref kref;
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;
234 struct dentry *dir;
235 struct dentry *dentry;
236 struct nfs4_state_owner *owner;
237 struct nfs4_state *state;
238 struct iattr attrs;
239 struct nfs4_layoutget *lgp;
240 unsigned long timestamp;
241 bool rpc_done;
242 bool file_created;
243 bool is_recover;
244 bool cancelled;
245 int rpc_status;
246};
247
248struct nfs4_add_xprt_data {
249 struct nfs_client *clp;
250 const struct cred *cred;
251};
252
253struct 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 *);
257};
258
259struct 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 *);
263};
264
265extern const struct dentry_operations nfs4_dentry_operations;
266
267
268int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
269 unsigned, umode_t);
270
271
272extern struct file_system_type nfs4_fs_type;
273
274
275struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
276 const struct qstr *);
277struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
278 struct nfs_fh *, struct nfs_fattr *);
279int nfs4_replace_transport(struct nfs_server *server,
280 const struct nfs4_fs_locations *locations);
281
282
283extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
284extern int nfs4_async_handle_error(struct rpc_task *task,
285 struct nfs_server *server,
286 struct nfs4_state *state, long *timeout);
287extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
288 struct rpc_message *, struct nfs4_sequence_args *,
289 struct nfs4_sequence_res *, int);
290extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
291extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, const struct cred *, struct nfs4_setclientid_res *);
292extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, const struct cred *);
293extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
294extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, const struct cred *cred);
295extern int nfs4_proc_exchange_id(struct nfs_client *clp, const struct cred *cred);
296extern int nfs4_destroy_clientid(struct nfs_client *clp);
297extern int nfs4_init_clientid(struct nfs_client *, const struct cred *);
298extern int nfs41_init_clientid(struct nfs_client *, const struct cred *);
299extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
300extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
301extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
302 struct nfs4_fs_locations *, struct page *);
303extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
304 struct page *page, const struct cred *);
305extern int nfs4_proc_fsid_present(struct inode *, const struct cred *);
306extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
307 struct nfs_fh *, struct nfs_fattr *);
308extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
309extern const struct xattr_handler *nfs4_xattr_handlers[];
310extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
311 const struct nfs_open_context *ctx,
312 const struct nfs_lock_context *l_ctx,
313 fmode_t fmode);
314
315extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
316 struct nfs_fsinfo *fsinfo);
317#if defined(CONFIG_NFS_V4_1)
318extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
319extern int nfs4_proc_create_session(struct nfs_client *, const struct cred *);
320extern int nfs4_proc_destroy_session(struct nfs4_session *, const struct cred *);
321extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
322 bool sync);
323extern int nfs4_detect_session_trunking(struct nfs_client *clp,
324 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
325
326static inline bool
327is_ds_only_client(struct nfs_client *clp)
328{
329 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
330 EXCHGID4_FLAG_USE_PNFS_DS;
331}
332
333static inline bool
334is_ds_client(struct nfs_client *clp)
335{
336 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
337}
338
339static inline bool
340_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
341 struct rpc_clnt **clntp, struct rpc_message *msg)
342{
343 rpc_authflavor_t flavor;
344
345 if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
346 sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
347
348
349
350
351
352
353 if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
354 return false;
355 }
356 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
357 msg->rpc_cred = rpc_machine_cred();
358
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;
363
364 return true;
365 }
366 return false;
367}
368
369
370
371
372
373
374
375static inline void
376nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
377 struct rpc_clnt **clntp, struct rpc_message *msg)
378{
379 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
380}
381
382
383
384
385
386
387static inline void
388nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
389 struct rpc_message *msg, struct nfs_pgio_header *hdr)
390{
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;
394}
395#else
396static inline bool
397is_ds_only_client(struct nfs_client *clp)
398{
399 return false;
400}
401
402static inline bool
403is_ds_client(struct nfs_client *clp)
404{
405 return false;
406}
407
408static inline void
409nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
410 struct rpc_clnt **clntp, struct rpc_message *msg)
411{
412}
413
414static inline void
415nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
416 struct rpc_message *msg, struct nfs_pgio_header *hdr)
417{
418}
419#endif
420
421extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
422
423extern const u32 nfs4_fattr_bitmap[3];
424extern const u32 nfs4_statfs_bitmap[3];
425extern const u32 nfs4_pathconf_bitmap[3];
426extern const u32 nfs4_fsinfo_bitmap[3];
427extern const u32 nfs4_fs_locations_bitmap[3];
428
429void nfs40_shutdown_client(struct nfs_client *);
430void nfs41_shutdown_client(struct nfs_client *);
431int nfs40_init_client(struct nfs_client *);
432int nfs41_init_client(struct nfs_client *);
433void nfs4_free_client(struct nfs_client *);
434
435struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
436
437
438extern void nfs4_schedule_state_renewal(struct nfs_client *);
439extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
440extern void nfs4_kill_renewd(struct nfs_client *);
441extern void nfs4_renew_state(struct work_struct *);
442extern void nfs4_set_lease_period(struct nfs_client *clp,
443 unsigned long lease,
444 unsigned long lastrenewed);
445
446
447
448const struct cred *nfs4_get_clid_cred(struct nfs_client *clp);
449const struct cred *nfs4_get_machine_cred(struct nfs_client *clp);
450const struct cred *nfs4_get_renew_cred(struct nfs_client *clp);
451int nfs4_discover_server_trunking(struct nfs_client *clp,
452 struct nfs_client **);
453int nfs40_discover_server_trunking(struct nfs_client *clp,
454 struct nfs_client **, const struct cred *);
455#if defined(CONFIG_NFS_V4_1)
456int nfs41_discover_server_trunking(struct nfs_client *clp,
457 struct nfs_client **, const struct cred *);
458extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
459extern void nfs41_notify_server(struct nfs_client *);
460#else
461static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
462{
463}
464#endif
465
466extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, const struct cred *, gfp_t);
467extern void nfs4_put_state_owner(struct nfs4_state_owner *);
468extern void nfs4_purge_state_owners(struct nfs_server *, struct list_head *);
469extern void nfs4_free_state_owners(struct list_head *head);
470extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
471extern void nfs4_put_open_state(struct nfs4_state *);
472extern void nfs4_close_state(struct nfs4_state *, fmode_t);
473extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
474extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
475extern void nfs_inode_find_state_and_recover(struct inode *inode,
476 const nfs4_stateid *stateid);
477extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
478extern void nfs4_schedule_lease_recovery(struct nfs_client *);
479extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
480extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
481extern void nfs4_schedule_state_manager(struct nfs_client *);
482extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
483extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
484extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
485extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
486extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
487extern void nfs41_handle_server_scope(struct nfs_client *,
488 struct nfs41_server_scope **);
489extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
490extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
491extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
492 const struct nfs_lock_context *, nfs4_stateid *,
493 const struct cred **);
494extern bool nfs4_refresh_open_stateid(nfs4_stateid *dst,
495 struct nfs4_state *state);
496extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
497 struct nfs4_state *state);
498
499extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
500extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
501extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
502extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
503extern void nfs_release_seqid(struct nfs_seqid *seqid);
504extern void nfs_free_seqid(struct nfs_seqid *seqid);
505extern 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);
509extern int nfs4_sequence_done(struct rpc_task *task,
510 struct nfs4_sequence_res *res);
511
512extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
513extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
514extern const nfs4_stateid zero_stateid;
515extern const nfs4_stateid invalid_stateid;
516
517
518struct nfs_mount_info;
519extern struct nfs_subversion nfs_v4;
520struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
521extern bool nfs4_disable_idmapping;
522extern unsigned short max_session_slots;
523extern unsigned short max_session_cb_slots;
524extern unsigned short send_implementation_id;
525extern bool recover_lost_locks;
526
527#define NFS4_CLIENT_ID_UNIQ_LEN (64)
528extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
529
530
531#ifdef CONFIG_SYSCTL
532int nfs4_register_sysctl(void);
533void nfs4_unregister_sysctl(void);
534#else
535static inline int nfs4_register_sysctl(void)
536{
537 return 0;
538}
539
540static inline void nfs4_unregister_sysctl(void)
541{
542}
543#endif
544
545
546extern const struct rpc_procinfo nfs4_procedures[];
547
548struct nfs4_mount_data;
549
550
551extern const struct svc_version nfs4_callback_version1;
552extern const struct svc_version nfs4_callback_version4;
553
554static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
555{
556 memcpy(dst->data, src->data, sizeof(dst->data));
557 dst->type = src->type;
558}
559
560static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
561{
562 if (dst->type != src->type)
563 return false;
564 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
565}
566
567static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
568{
569 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
570}
571
572static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
573{
574 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
575}
576
577static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
578{
579 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
580}
581
582static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
583 const nfs4_stateid *stateid)
584{
585 return test_bit(NFS_OPEN_STATE, &state->flags) &&
586 nfs4_stateid_match_other(&state->open_stateid, stateid);
587}
588
589#else
590
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)
595
596#endif
597#endif
598