Loading...
1/*
2 * linux/fs/nfs/nfs4_fs.h
3 *
4 * Copyright (C) 2005 Trond Myklebust
5 *
6 * NFSv4-specific filesystem definitions and declarations
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 NFS4CLNT_DELEGATION_EXPIRED,
43};
44
45#define NFS4_RENEW_TIMEOUT 0x01
46#define NFS4_RENEW_DELEGATION_CB 0x02
47
48struct nfs_seqid_counter;
49struct nfs4_minor_version_ops {
50 u32 minor_version;
51 unsigned init_caps;
52
53 int (*init_client)(struct nfs_client *);
54 void (*shutdown_client)(struct nfs_client *);
55 bool (*match_stateid)(const nfs4_stateid *,
56 const nfs4_stateid *);
57 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
58 struct nfs_fsinfo *);
59 void (*free_lock_state)(struct nfs_server *,
60 struct nfs4_lock_state *);
61 int (*test_and_free_expired)(struct nfs_server *,
62 nfs4_stateid *, struct rpc_cred *);
63 struct nfs_seqid *
64 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
65 int (*session_trunk)(struct rpc_clnt *, struct rpc_xprt *, void *);
66 const struct rpc_call_ops *call_sync_ops;
67 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
68 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
69 const struct nfs4_state_maintenance_ops *state_renewal_ops;
70 const struct nfs4_mig_recovery_ops *mig_recovery_ops;
71};
72
73#define NFS_SEQID_CONFIRMED 1
74struct nfs_seqid_counter {
75 ktime_t create_time;
76 int owner_id;
77 int flags;
78 u32 counter;
79 spinlock_t lock; /* Protects the list */
80 struct list_head list; /* Defines sequence of RPC calls */
81 struct rpc_wait_queue wait; /* RPC call delay queue */
82};
83
84struct nfs_seqid {
85 struct nfs_seqid_counter *sequence;
86 struct list_head list;
87 struct rpc_task *task;
88};
89
90static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
91{
92 if (seqid_mutating_err(-status))
93 seqid->flags |= NFS_SEQID_CONFIRMED;
94}
95
96/*
97 * NFS4 state_owners and lock_owners are simply labels for ordered
98 * sequences of RPC calls. Their sole purpose is to provide once-only
99 * semantics by allowing the server to identify replayed requests.
100 */
101struct nfs4_state_owner {
102 struct nfs_server *so_server;
103 struct list_head so_lru;
104 unsigned long so_expires;
105 struct rb_node so_server_node;
106
107 struct rpc_cred *so_cred; /* Associated cred */
108
109 spinlock_t so_lock;
110 atomic_t so_count;
111 unsigned long so_flags;
112 struct list_head so_states;
113 struct nfs_seqid_counter so_seqid;
114 seqcount_t so_reclaim_seqcount;
115 struct mutex so_delegreturn_mutex;
116};
117
118enum {
119 NFS_OWNER_RECLAIM_REBOOT,
120 NFS_OWNER_RECLAIM_NOGRACE
121};
122
123#define NFS_LOCK_NEW 0
124#define NFS_LOCK_RECLAIM 1
125#define NFS_LOCK_EXPIRED 2
126
127/*
128 * struct nfs4_state maintains the client-side state for a given
129 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
130 *
131 * OPEN:
132 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
133 * we need to know how many files are open for reading or writing on a
134 * given inode. This information too is stored here.
135 *
136 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
137 */
138
139struct nfs4_lock_state {
140 struct list_head ls_locks; /* Other lock stateids */
141 struct nfs4_state * ls_state; /* Pointer to open state */
142#define NFS_LOCK_INITIALIZED 0
143#define NFS_LOCK_LOST 1
144 unsigned long ls_flags;
145 struct nfs_seqid_counter ls_seqid;
146 nfs4_stateid ls_stateid;
147 atomic_t ls_count;
148 fl_owner_t ls_owner;
149};
150
151/* bits for nfs4_state->flags */
152enum {
153 LK_STATE_IN_USE,
154 NFS_DELEGATED_STATE, /* Current stateid is delegation */
155 NFS_OPEN_STATE, /* OPEN stateid is set */
156 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
157 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
158 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
159 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
160 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
161 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
162 NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
163 NFS_STATE_MAY_NOTIFY_LOCK, /* server may CB_NOTIFY_LOCK */
164};
165
166struct nfs4_state {
167 struct list_head open_states; /* List of states for the same state_owner */
168 struct list_head inode_states; /* List of states for the same inode */
169 struct list_head lock_states; /* List of subservient lock stateids */
170
171 struct nfs4_state_owner *owner; /* Pointer to the open owner */
172 struct inode *inode; /* Pointer to the inode */
173
174 unsigned long flags; /* Do we hold any locks? */
175 spinlock_t state_lock; /* Protects the lock_states list */
176
177 seqlock_t seqlock; /* Protects the stateid/open_stateid */
178 nfs4_stateid stateid; /* Current stateid: may be delegation */
179 nfs4_stateid open_stateid; /* OPEN stateid */
180
181 /* The following 3 fields are protected by owner->so_lock */
182 unsigned int n_rdonly; /* Number of read-only references */
183 unsigned int n_wronly; /* Number of write-only references */
184 unsigned int n_rdwr; /* Number of read/write references */
185 fmode_t state; /* State on the server (R,W, or RW) */
186 atomic_t count;
187};
188
189
190struct nfs4_exception {
191 struct nfs4_state *state;
192 struct inode *inode;
193 nfs4_stateid *stateid;
194 long timeout;
195 unsigned char delay : 1,
196 recovering : 1,
197 retry : 1;
198};
199
200struct nfs4_state_recovery_ops {
201 int owner_flag_bit;
202 int state_flag_bit;
203 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
204 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
205 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
206 int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
207 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
208 struct rpc_cred *);
209};
210
211struct nfs4_add_xprt_data {
212 struct nfs_client *clp;
213 struct rpc_cred *cred;
214};
215
216struct nfs4_state_maintenance_ops {
217 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
218 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
219 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
220};
221
222struct nfs4_mig_recovery_ops {
223 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
224 struct page *, struct rpc_cred *);
225 int (*fsid_present)(struct inode *, struct rpc_cred *);
226};
227
228extern const struct dentry_operations nfs4_dentry_operations;
229
230/* dir.c */
231int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
232 unsigned, umode_t, int *);
233
234/* super.c */
235extern struct file_system_type nfs4_fs_type;
236
237/* nfs4namespace.c */
238struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
239 const struct qstr *);
240struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
241 struct nfs_fh *, struct nfs_fattr *);
242int nfs4_replace_transport(struct nfs_server *server,
243 const struct nfs4_fs_locations *locations);
244
245/* nfs4proc.c */
246extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
247extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
248 struct rpc_message *, struct nfs4_sequence_args *,
249 struct nfs4_sequence_res *, int);
250extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int);
251extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
252extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
253extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
254extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
255extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
256extern int nfs4_destroy_clientid(struct nfs_client *clp);
257extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
258extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
259extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
260extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
261extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
262 struct nfs4_fs_locations *, struct page *);
263extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
264 struct page *page, struct rpc_cred *);
265extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
266extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
267 struct nfs_fh *, struct nfs_fattr *);
268extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
269extern const struct xattr_handler *nfs4_xattr_handlers[];
270extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
271 const struct nfs_open_context *ctx,
272 const struct nfs_lock_context *l_ctx,
273 fmode_t fmode);
274
275#if defined(CONFIG_NFS_V4_1)
276static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
277{
278 return server->nfs_client->cl_session;
279}
280
281extern int nfs41_setup_sequence(struct nfs4_session *session,
282 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
283 struct rpc_task *task);
284extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
285extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
286extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
287extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
288 struct nfs_fsinfo *fsinfo);
289extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
290 bool sync);
291extern int nfs4_detect_session_trunking(struct nfs_client *clp,
292 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
293
294static inline bool
295is_ds_only_client(struct nfs_client *clp)
296{
297 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
298 EXCHGID4_FLAG_USE_PNFS_DS;
299}
300
301static inline bool
302is_ds_client(struct nfs_client *clp)
303{
304 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
305}
306
307static inline bool
308_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
309 struct rpc_clnt **clntp, struct rpc_message *msg)
310{
311 struct rpc_cred *newcred = NULL;
312 rpc_authflavor_t flavor;
313
314 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
315 spin_lock(&clp->cl_lock);
316 if (clp->cl_machine_cred != NULL)
317 /* don't call get_rpccred on the machine cred -
318 * a reference will be held for life of clp */
319 newcred = clp->cl_machine_cred;
320 spin_unlock(&clp->cl_lock);
321 msg->rpc_cred = newcred;
322
323 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
324 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
325 flavor != RPC_AUTH_GSS_KRB5P);
326 *clntp = clp->cl_rpcclient;
327
328 return true;
329 }
330 return false;
331}
332
333/*
334 * Function responsible for determining if an rpc_message should use the
335 * machine cred under SP4_MACH_CRED and if so switching the credential and
336 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
337 * Should be called before rpc_call_sync/rpc_call_async.
338 */
339static inline void
340nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
341 struct rpc_clnt **clntp, struct rpc_message *msg)
342{
343 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
344}
345
346/*
347 * Special wrapper to nfs4_state_protect for write.
348 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
349 * that use machine cred use NFS_FILE_SYNC.
350 */
351static inline void
352nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
353 struct rpc_message *msg, struct nfs_pgio_header *hdr)
354{
355 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
356 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
357 hdr->args.stable = NFS_FILE_SYNC;
358}
359#else /* CONFIG_NFS_v4_1 */
360static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
361{
362 return NULL;
363}
364
365static inline bool
366is_ds_only_client(struct nfs_client *clp)
367{
368 return false;
369}
370
371static inline bool
372is_ds_client(struct nfs_client *clp)
373{
374 return false;
375}
376
377static inline void
378nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
379 struct rpc_clnt **clntp, struct rpc_message *msg)
380{
381}
382
383static inline void
384nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
385 struct rpc_message *msg, struct nfs_pgio_header *hdr)
386{
387}
388#endif /* CONFIG_NFS_V4_1 */
389
390extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
391
392extern const u32 nfs4_fattr_bitmap[3];
393extern const u32 nfs4_statfs_bitmap[3];
394extern const u32 nfs4_pathconf_bitmap[3];
395extern const u32 nfs4_fsinfo_bitmap[3];
396extern const u32 nfs4_fs_locations_bitmap[3];
397
398void nfs40_shutdown_client(struct nfs_client *);
399void nfs41_shutdown_client(struct nfs_client *);
400int nfs40_init_client(struct nfs_client *);
401int nfs41_init_client(struct nfs_client *);
402void nfs4_free_client(struct nfs_client *);
403
404struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
405
406/* nfs4renewd.c */
407extern void nfs4_schedule_state_renewal(struct nfs_client *);
408extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
409extern void nfs4_kill_renewd(struct nfs_client *);
410extern void nfs4_renew_state(struct work_struct *);
411extern void nfs4_set_lease_period(struct nfs_client *clp,
412 unsigned long lease,
413 unsigned long lastrenewed);
414
415
416/* nfs4state.c */
417struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
418struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
419struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
420int nfs4_discover_server_trunking(struct nfs_client *clp,
421 struct nfs_client **);
422int nfs40_discover_server_trunking(struct nfs_client *clp,
423 struct nfs_client **, struct rpc_cred *);
424#if defined(CONFIG_NFS_V4_1)
425int nfs41_discover_server_trunking(struct nfs_client *clp,
426 struct nfs_client **, struct rpc_cred *);
427extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
428extern void nfs41_notify_server(struct nfs_client *);
429#else
430static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
431{
432}
433#endif /* CONFIG_NFS_V4_1 */
434
435extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
436extern void nfs4_put_state_owner(struct nfs4_state_owner *);
437extern void nfs4_purge_state_owners(struct nfs_server *);
438extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
439extern void nfs4_put_open_state(struct nfs4_state *);
440extern void nfs4_close_state(struct nfs4_state *, fmode_t);
441extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
442extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
443extern void nfs_inode_find_state_and_recover(struct inode *inode,
444 const nfs4_stateid *stateid);
445extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
446extern void nfs4_schedule_lease_recovery(struct nfs_client *);
447extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
448extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
449extern void nfs4_schedule_state_manager(struct nfs_client *);
450extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
451extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
452extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
453extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
454extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
455extern void nfs41_handle_server_scope(struct nfs_client *,
456 struct nfs41_server_scope **);
457extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
458extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
459extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
460 const struct nfs_lock_context *, nfs4_stateid *,
461 struct rpc_cred **);
462
463extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
464extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
465extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
466extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
467extern void nfs_release_seqid(struct nfs_seqid *seqid);
468extern void nfs_free_seqid(struct nfs_seqid *seqid);
469extern int nfs40_setup_sequence(struct nfs4_slot_table *tbl,
470 struct nfs4_sequence_args *args,
471 struct nfs4_sequence_res *res,
472 struct rpc_task *task);
473extern int nfs4_sequence_done(struct rpc_task *task,
474 struct nfs4_sequence_res *res);
475
476extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
477
478extern const nfs4_stateid zero_stateid;
479
480/* nfs4super.c */
481struct nfs_mount_info;
482extern struct nfs_subversion nfs_v4;
483struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
484extern bool nfs4_disable_idmapping;
485extern unsigned short max_session_slots;
486extern unsigned short max_session_cb_slots;
487extern unsigned short send_implementation_id;
488extern bool recover_lost_locks;
489
490#define NFS4_CLIENT_ID_UNIQ_LEN (64)
491extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
492
493/* nfs4sysctl.c */
494#ifdef CONFIG_SYSCTL
495int nfs4_register_sysctl(void);
496void nfs4_unregister_sysctl(void);
497#else
498static inline int nfs4_register_sysctl(void)
499{
500 return 0;
501}
502
503static inline void nfs4_unregister_sysctl(void)
504{
505}
506#endif
507
508/* nfs4xdr.c */
509extern struct rpc_procinfo nfs4_procedures[];
510
511struct nfs4_mount_data;
512
513/* callback_xdr.c */
514extern struct svc_version nfs4_callback_version1;
515extern struct svc_version nfs4_callback_version4;
516
517static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
518{
519 memcpy(dst->data, src->data, sizeof(dst->data));
520 dst->type = src->type;
521}
522
523static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
524{
525 if (dst->type != src->type)
526 return false;
527 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
528}
529
530static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
531{
532 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
533}
534
535static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
536{
537 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
538}
539
540static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
541{
542 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
543}
544
545static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
546 const nfs4_stateid *stateid)
547{
548 return test_bit(NFS_OPEN_STATE, &state->flags) &&
549 nfs4_stateid_match_other(&state->open_stateid, stateid);
550}
551
552#else
553
554#define nfs4_close_state(a, b) do { } while (0)
555#define nfs4_close_sync(a, b) do { } while (0)
556#define nfs4_state_protect(a, b, c, d) do { } while (0)
557#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
558
559#endif /* CONFIG_NFS_V4 */
560#endif /* __LINUX_FS_NFS_NFS4_FS.H */
1/*
2 * linux/fs/nfs/nfs4_fs.h
3 *
4 * Copyright (C) 2005 Trond Myklebust
5 *
6 * NFSv4-specific filesystem definitions and declarations
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; /* Protects the list */
76 struct list_head list; /* Defines sequence of RPC calls */
77 struct rpc_wait_queue wait; /* RPC call delay queue */
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 * NFS4 state_owners and lock_owners are simply labels for ordered
94 * sequences of RPC calls. Their sole purpose is to provide once-only
95 * semantics by allowing the server to identify replayed requests.
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; /* Associated 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 * struct nfs4_state maintains the client-side state for a given
125 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
126 *
127 * OPEN:
128 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
129 * we need to know how many files are open for reading or writing on a
130 * given inode. This information too is stored here.
131 *
132 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
133 */
134
135struct nfs4_lock_state {
136 struct list_head ls_locks; /* Other lock stateids */
137 struct nfs4_state * ls_state; /* Pointer to open 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/* bits for nfs4_state->flags */
148enum {
149 LK_STATE_IN_USE,
150 NFS_DELEGATED_STATE, /* Current stateid is delegation */
151 NFS_OPEN_STATE, /* OPEN stateid is set */
152 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
153 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
154 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
155 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
156 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
157 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
158 NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
159};
160
161struct nfs4_state {
162 struct list_head open_states; /* List of states for the same state_owner */
163 struct list_head inode_states; /* List of states for the same inode */
164 struct list_head lock_states; /* List of subservient lock stateids */
165
166 struct nfs4_state_owner *owner; /* Pointer to the open owner */
167 struct inode *inode; /* Pointer to the inode */
168
169 unsigned long flags; /* Do we hold any locks? */
170 spinlock_t state_lock; /* Protects the lock_states list */
171
172 seqlock_t seqlock; /* Protects the stateid/open_stateid */
173 nfs4_stateid stateid; /* Current stateid: may be delegation */
174 nfs4_stateid open_stateid; /* OPEN stateid */
175
176 /* The following 3 fields are protected by owner->so_lock */
177 unsigned int n_rdonly; /* Number of read-only references */
178 unsigned int n_wronly; /* Number of write-only references */
179 unsigned int n_rdwr; /* Number of read/write references */
180 fmode_t state; /* State on the server (R,W, or RW) */
181 atomic_t count;
182};
183
184
185struct nfs4_exception {
186 struct nfs4_state *state;
187 struct inode *inode;
188 long timeout;
189 unsigned char delay : 1,
190 recovering : 1,
191 retry : 1;
192};
193
194struct nfs4_state_recovery_ops {
195 int owner_flag_bit;
196 int state_flag_bit;
197 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
198 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
199 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
200 int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
201 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
202 struct rpc_cred *);
203};
204
205struct nfs4_state_maintenance_ops {
206 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
207 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
208 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
209};
210
211struct nfs4_mig_recovery_ops {
212 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
213 struct page *, struct rpc_cred *);
214 int (*fsid_present)(struct inode *, struct rpc_cred *);
215};
216
217extern const struct dentry_operations nfs4_dentry_operations;
218
219/* dir.c */
220int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
221 unsigned, umode_t, int *);
222
223/* super.c */
224extern struct file_system_type nfs4_fs_type;
225
226/* nfs4namespace.c */
227struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *, struct qstr *);
228struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
229 struct nfs_fh *, struct nfs_fattr *);
230int nfs4_replace_transport(struct nfs_server *server,
231 const struct nfs4_fs_locations *locations);
232
233/* nfs4proc.c */
234extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
235extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
236 struct rpc_message *, struct nfs4_sequence_args *,
237 struct nfs4_sequence_res *, int);
238extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int);
239extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
240extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
241extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
242extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
243extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
244extern int nfs4_destroy_clientid(struct nfs_client *clp);
245extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
246extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
247extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
248extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
249extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
250 struct nfs4_fs_locations *, struct page *);
251extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
252 struct page *page, struct rpc_cred *);
253extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
254extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
255 struct nfs_fh *, struct nfs_fattr *);
256extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
257extern const struct xattr_handler *nfs4_xattr_handlers[];
258extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
259 const struct nfs_open_context *ctx,
260 const struct nfs_lock_context *l_ctx,
261 fmode_t fmode);
262
263#if defined(CONFIG_NFS_V4_1)
264static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
265{
266 return server->nfs_client->cl_session;
267}
268
269extern int nfs41_setup_sequence(struct nfs4_session *session,
270 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
271 struct rpc_task *task);
272extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
273extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
274extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
275extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
276 struct nfs_fsinfo *fsinfo);
277extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
278 bool sync);
279
280static inline bool
281is_ds_only_client(struct nfs_client *clp)
282{
283 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
284 EXCHGID4_FLAG_USE_PNFS_DS;
285}
286
287static inline bool
288is_ds_client(struct nfs_client *clp)
289{
290 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
291}
292
293static inline bool
294_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
295 struct rpc_clnt **clntp, struct rpc_message *msg)
296{
297 struct rpc_cred *newcred = NULL;
298 rpc_authflavor_t flavor;
299
300 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
301 spin_lock(&clp->cl_lock);
302 if (clp->cl_machine_cred != NULL)
303 /* don't call get_rpccred on the machine cred -
304 * a reference will be held for life of clp */
305 newcred = clp->cl_machine_cred;
306 spin_unlock(&clp->cl_lock);
307 msg->rpc_cred = newcred;
308
309 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
310 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
311 flavor != RPC_AUTH_GSS_KRB5P);
312 *clntp = clp->cl_rpcclient;
313
314 return true;
315 }
316 return false;
317}
318
319/*
320 * Function responsible for determining if an rpc_message should use the
321 * machine cred under SP4_MACH_CRED and if so switching the credential and
322 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
323 * Should be called before rpc_call_sync/rpc_call_async.
324 */
325static inline void
326nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
327 struct rpc_clnt **clntp, struct rpc_message *msg)
328{
329 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
330}
331
332/*
333 * Special wrapper to nfs4_state_protect for write.
334 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
335 * that use machine cred use NFS_FILE_SYNC.
336 */
337static inline void
338nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
339 struct rpc_message *msg, struct nfs_pgio_header *hdr)
340{
341 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
342 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
343 hdr->args.stable = NFS_FILE_SYNC;
344}
345#else /* CONFIG_NFS_v4_1 */
346static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
347{
348 return NULL;
349}
350
351static inline bool
352is_ds_only_client(struct nfs_client *clp)
353{
354 return false;
355}
356
357static inline bool
358is_ds_client(struct nfs_client *clp)
359{
360 return false;
361}
362
363static inline void
364nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
365 struct rpc_clnt **clntp, struct rpc_message *msg)
366{
367}
368
369static inline void
370nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
371 struct rpc_message *msg, struct nfs_pgio_header *hdr)
372{
373}
374#endif /* CONFIG_NFS_V4_1 */
375
376extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
377
378extern const u32 nfs4_fattr_bitmap[3];
379extern const u32 nfs4_statfs_bitmap[3];
380extern const u32 nfs4_pathconf_bitmap[3];
381extern const u32 nfs4_fsinfo_bitmap[3];
382extern const u32 nfs4_fs_locations_bitmap[3];
383
384void nfs40_shutdown_client(struct nfs_client *);
385void nfs41_shutdown_client(struct nfs_client *);
386int nfs40_init_client(struct nfs_client *);
387int nfs41_init_client(struct nfs_client *);
388void nfs4_free_client(struct nfs_client *);
389
390struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
391
392/* nfs4renewd.c */
393extern void nfs4_schedule_state_renewal(struct nfs_client *);
394extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
395extern void nfs4_kill_renewd(struct nfs_client *);
396extern void nfs4_renew_state(struct work_struct *);
397
398/* nfs4state.c */
399struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
400struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
401struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
402int nfs4_discover_server_trunking(struct nfs_client *clp,
403 struct nfs_client **);
404int nfs40_discover_server_trunking(struct nfs_client *clp,
405 struct nfs_client **, struct rpc_cred *);
406#if defined(CONFIG_NFS_V4_1)
407int nfs41_discover_server_trunking(struct nfs_client *clp,
408 struct nfs_client **, struct rpc_cred *);
409extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
410extern void nfs41_notify_server(struct nfs_client *);
411#else
412static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
413{
414}
415#endif /* CONFIG_NFS_V4_1 */
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/* nfs4super.c */
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/* nfs4sysctl.c */
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/* nfs4xdr.c */
489extern struct rpc_procinfo nfs4_procedures[];
490
491struct nfs4_mount_data;
492
493/* callback_xdr.c */
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 /* CONFIG_NFS_V4 */
530#endif /* __LINUX_FS_NFS_NFS4_FS.H */