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 NFS_CLNT_DST_SSC_COPY_STATE,
170 NFS_CLNT_SRC_SSC_COPY_STATE,
171 NFS_SRV_SSC_COPY_STATE,
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 *);
277int nfs4_submount(struct fs_context *, struct nfs_server *);
278int nfs4_replace_transport(struct nfs_server *server,
279 const struct nfs4_fs_locations *locations);
280
281
282extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
283extern int nfs4_async_handle_error(struct rpc_task *task,
284 struct nfs_server *server,
285 struct nfs4_state *state, long *timeout);
286extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
287 struct rpc_message *, struct nfs4_sequence_args *,
288 struct nfs4_sequence_res *, int);
289extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
290extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, const struct cred *, struct nfs4_setclientid_res *);
291extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, const struct cred *);
292extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
293extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, const struct cred *cred);
294extern int nfs4_proc_exchange_id(struct nfs_client *clp, const struct cred *cred);
295extern int nfs4_destroy_clientid(struct nfs_client *clp);
296extern int nfs4_init_clientid(struct nfs_client *, const struct cred *);
297extern int nfs41_init_clientid(struct nfs_client *, const struct cred *);
298extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
299extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
300extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
301 struct nfs4_fs_locations *, struct page *);
302extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
303 struct page *page, const struct cred *);
304extern int nfs4_proc_fsid_present(struct inode *, const struct cred *);
305extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *,
306 struct dentry *,
307 struct nfs_fh *,
308 struct nfs_fattr *);
309extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
310extern const struct xattr_handler *nfs4_xattr_handlers[];
311extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
312 const struct nfs_open_context *ctx,
313 const struct nfs_lock_context *l_ctx,
314 fmode_t fmode);
315extern int nfs4_proc_getattr(struct nfs_server *server, struct nfs_fh *fhandle,
316 struct nfs_fattr *fattr, struct nfs4_label *label,
317 struct inode *inode);
318extern int update_open_stateid(struct nfs4_state *state,
319 const nfs4_stateid *open_stateid,
320 const nfs4_stateid *deleg_stateid,
321 fmode_t fmode);
322
323extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
324 struct nfs_fsinfo *fsinfo);
325#if defined(CONFIG_NFS_V4_1)
326extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
327extern int nfs4_proc_create_session(struct nfs_client *, const struct cred *);
328extern int nfs4_proc_destroy_session(struct nfs4_session *, const struct cred *);
329extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
330 bool sync);
331extern int nfs4_detect_session_trunking(struct nfs_client *clp,
332 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
333
334static inline bool
335is_ds_only_client(struct nfs_client *clp)
336{
337 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
338 EXCHGID4_FLAG_USE_PNFS_DS;
339}
340
341static inline bool
342is_ds_client(struct nfs_client *clp)
343{
344 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
345}
346
347static inline bool
348_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
349 struct rpc_clnt **clntp, struct rpc_message *msg)
350{
351 rpc_authflavor_t flavor;
352
353 if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
354 sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
355
356
357
358
359
360
361 if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
362 return false;
363 }
364 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
365 msg->rpc_cred = rpc_machine_cred();
366
367 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
368 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
369 flavor != RPC_AUTH_GSS_KRB5P);
370 *clntp = clp->cl_rpcclient;
371
372 return true;
373 }
374 return false;
375}
376
377
378
379
380
381
382
383static inline void
384nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
385 struct rpc_clnt **clntp, struct rpc_message *msg)
386{
387 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
388}
389
390
391
392
393
394
395static inline void
396nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
397 struct rpc_message *msg, struct nfs_pgio_header *hdr)
398{
399 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
400 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
401 hdr->args.stable = NFS_FILE_SYNC;
402}
403#else
404static inline bool
405is_ds_only_client(struct nfs_client *clp)
406{
407 return false;
408}
409
410static inline bool
411is_ds_client(struct nfs_client *clp)
412{
413 return false;
414}
415
416static inline void
417nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
418 struct rpc_clnt **clntp, struct rpc_message *msg)
419{
420}
421
422static inline void
423nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
424 struct rpc_message *msg, struct nfs_pgio_header *hdr)
425{
426}
427#endif
428
429extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
430
431extern const u32 nfs4_fattr_bitmap[3];
432extern const u32 nfs4_statfs_bitmap[3];
433extern const u32 nfs4_pathconf_bitmap[3];
434extern const u32 nfs4_fsinfo_bitmap[3];
435extern const u32 nfs4_fs_locations_bitmap[3];
436
437void nfs40_shutdown_client(struct nfs_client *);
438void nfs41_shutdown_client(struct nfs_client *);
439int nfs40_init_client(struct nfs_client *);
440int nfs41_init_client(struct nfs_client *);
441void nfs4_free_client(struct nfs_client *);
442
443struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
444
445
446extern void nfs4_schedule_state_renewal(struct nfs_client *);
447extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
448extern void nfs4_kill_renewd(struct nfs_client *);
449extern void nfs4_renew_state(struct work_struct *);
450extern void nfs4_set_lease_period(struct nfs_client *clp, unsigned long lease);
451
452
453
454extern const nfs4_stateid current_stateid;
455
456const struct cred *nfs4_get_clid_cred(struct nfs_client *clp);
457const struct cred *nfs4_get_machine_cred(struct nfs_client *clp);
458const struct cred *nfs4_get_renew_cred(struct nfs_client *clp);
459int nfs4_discover_server_trunking(struct nfs_client *clp,
460 struct nfs_client **);
461int nfs40_discover_server_trunking(struct nfs_client *clp,
462 struct nfs_client **, const struct cred *);
463#if defined(CONFIG_NFS_V4_1)
464int nfs41_discover_server_trunking(struct nfs_client *clp,
465 struct nfs_client **, const struct cred *);
466extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
467extern void nfs41_notify_server(struct nfs_client *);
468bool nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
469 struct nfs41_server_owner *o2);
470#else
471static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
472{
473}
474#endif
475
476extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, const struct cred *, gfp_t);
477extern void nfs4_put_state_owner(struct nfs4_state_owner *);
478extern void nfs4_purge_state_owners(struct nfs_server *, struct list_head *);
479extern void nfs4_free_state_owners(struct list_head *head);
480extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
481extern void nfs4_put_open_state(struct nfs4_state *);
482extern void nfs4_close_state(struct nfs4_state *, fmode_t);
483extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
484extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
485extern void nfs_inode_find_state_and_recover(struct inode *inode,
486 const nfs4_stateid *stateid);
487extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
488extern void nfs4_schedule_lease_recovery(struct nfs_client *);
489extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
490extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
491extern void nfs4_schedule_state_manager(struct nfs_client *);
492extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
493extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
494extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
495extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
496extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
497extern void nfs41_handle_server_scope(struct nfs_client *,
498 struct nfs41_server_scope **);
499extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
500extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
501extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
502 const struct nfs_lock_context *, nfs4_stateid *,
503 const struct cred **);
504extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
505 struct nfs4_state *state);
506
507extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
508extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
509extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
510extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
511extern void nfs_release_seqid(struct nfs_seqid *seqid);
512extern void nfs_free_seqid(struct nfs_seqid *seqid);
513extern int nfs4_setup_sequence(struct nfs_client *client,
514 struct nfs4_sequence_args *args,
515 struct nfs4_sequence_res *res,
516 struct rpc_task *task);
517extern int nfs4_sequence_done(struct rpc_task *task,
518 struct nfs4_sequence_res *res);
519
520extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
521extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
522extern const nfs4_stateid zero_stateid;
523extern const nfs4_stateid invalid_stateid;
524
525
526struct nfs_mount_info;
527extern struct nfs_subversion nfs_v4;
528extern bool nfs4_disable_idmapping;
529extern unsigned short max_session_slots;
530extern unsigned short max_session_cb_slots;
531extern unsigned short send_implementation_id;
532extern bool recover_lost_locks;
533
534#define NFS4_CLIENT_ID_UNIQ_LEN (64)
535extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
536
537extern int nfs4_try_get_tree(struct fs_context *);
538extern int nfs4_get_referral_tree(struct fs_context *);
539
540
541#ifdef CONFIG_SYSCTL
542int nfs4_register_sysctl(void);
543void nfs4_unregister_sysctl(void);
544#else
545static inline int nfs4_register_sysctl(void)
546{
547 return 0;
548}
549
550static inline void nfs4_unregister_sysctl(void)
551{
552}
553#endif
554
555
556extern const struct rpc_procinfo nfs4_procedures[];
557
558struct nfs4_mount_data;
559
560
561extern const struct svc_version nfs4_callback_version1;
562extern const struct svc_version nfs4_callback_version4;
563
564static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
565{
566 memcpy(dst->data, src->data, sizeof(dst->data));
567 dst->type = src->type;
568}
569
570static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
571{
572 if (dst->type != src->type)
573 return false;
574 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
575}
576
577static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
578{
579 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
580}
581
582static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
583{
584 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
585}
586
587static inline bool nfs4_stateid_match_or_older(const nfs4_stateid *dst, const nfs4_stateid *src)
588{
589 return nfs4_stateid_match_other(dst, src) &&
590 !(src->seqid && nfs4_stateid_is_newer(dst, src));
591}
592
593static inline void nfs4_stateid_seqid_inc(nfs4_stateid *s1)
594{
595 u32 seqid = be32_to_cpu(s1->seqid);
596
597 if (++seqid == 0)
598 ++seqid;
599 s1->seqid = cpu_to_be32(seqid);
600}
601
602static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
603{
604 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
605}
606
607static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
608 const nfs4_stateid *stateid)
609{
610 return test_bit(NFS_OPEN_STATE, &state->flags) &&
611 nfs4_stateid_match_other(&state->open_stateid, stateid);
612}
613
614#else
615
616#define nfs4_close_state(a, b) do { } while (0)
617#define nfs4_close_sync(a, b) do { } while (0)
618#define nfs4_state_protect(a, b, c, d) do { } while (0)
619#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
620
621#endif
622#endif
623