]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame_incremental - fs/nfs/nfs4_fs.h
Enable previous version support
[mirror_ubuntu-bionic-kernel.git] / fs / nfs / nfs4_fs.h
... / ...
CommitLineData
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 nfs4_stateid *stateid;
189 long timeout;
190 unsigned char delay : 1,
191 recovering : 1,
192 retry : 1;
193};
194
195struct nfs4_state_recovery_ops {
196 int owner_flag_bit;
197 int state_flag_bit;
198 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
199 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
200 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
201 int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
202 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
203 struct rpc_cred *);
204};
205
206struct nfs4_state_maintenance_ops {
207 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
208 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
209 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
210};
211
212struct nfs4_mig_recovery_ops {
213 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
214 struct page *, struct rpc_cred *);
215 int (*fsid_present)(struct inode *, struct rpc_cred *);
216};
217
218extern const struct dentry_operations nfs4_dentry_operations;
219
220/* dir.c */
221int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
222 unsigned, umode_t, int *);
223
224/* super.c */
225extern struct file_system_type nfs4_fs_type;
226
227/* nfs4namespace.c */
228struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
229 const struct qstr *);
230struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
231 struct nfs_fh *, struct nfs_fattr *);
232int nfs4_replace_transport(struct nfs_server *server,
233 const struct nfs4_fs_locations *locations);
234
235/* nfs4proc.c */
236extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
237extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
238 struct rpc_message *, struct nfs4_sequence_args *,
239 struct nfs4_sequence_res *, int);
240extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int);
241extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
242extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
243extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
244extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
245extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
246extern int nfs4_destroy_clientid(struct nfs_client *clp);
247extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
248extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
249extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
250extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
251extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
252 struct nfs4_fs_locations *, struct page *);
253extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
254 struct page *page, struct rpc_cred *);
255extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
256extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
257 struct nfs_fh *, struct nfs_fattr *);
258extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
259extern const struct xattr_handler *nfs4_xattr_handlers[];
260extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
261 const struct nfs_open_context *ctx,
262 const struct nfs_lock_context *l_ctx,
263 fmode_t fmode);
264
265#if defined(CONFIG_NFS_V4_1)
266static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
267{
268 return server->nfs_client->cl_session;
269}
270
271extern int nfs41_setup_sequence(struct nfs4_session *session,
272 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
273 struct rpc_task *task);
274extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
275extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
276extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
277extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
278 struct nfs_fsinfo *fsinfo);
279extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
280 bool sync);
281
282static inline bool
283is_ds_only_client(struct nfs_client *clp)
284{
285 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
286 EXCHGID4_FLAG_USE_PNFS_DS;
287}
288
289static inline bool
290is_ds_client(struct nfs_client *clp)
291{
292 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
293}
294
295static inline bool
296_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
297 struct rpc_clnt **clntp, struct rpc_message *msg)
298{
299 struct rpc_cred *newcred = NULL;
300 rpc_authflavor_t flavor;
301
302 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
303 spin_lock(&clp->cl_lock);
304 if (clp->cl_machine_cred != NULL)
305 /* don't call get_rpccred on the machine cred -
306 * a reference will be held for life of clp */
307 newcred = clp->cl_machine_cred;
308 spin_unlock(&clp->cl_lock);
309 msg->rpc_cred = newcred;
310
311 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
312 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
313 flavor != RPC_AUTH_GSS_KRB5P);
314 *clntp = clp->cl_rpcclient;
315
316 return true;
317 }
318 return false;
319}
320
321/*
322 * Function responsible for determining if an rpc_message should use the
323 * machine cred under SP4_MACH_CRED and if so switching the credential and
324 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
325 * Should be called before rpc_call_sync/rpc_call_async.
326 */
327static inline void
328nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
329 struct rpc_clnt **clntp, struct rpc_message *msg)
330{
331 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
332}
333
334/*
335 * Special wrapper to nfs4_state_protect for write.
336 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
337 * that use machine cred use NFS_FILE_SYNC.
338 */
339static inline void
340nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
341 struct rpc_message *msg, struct nfs_pgio_header *hdr)
342{
343 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
344 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
345 hdr->args.stable = NFS_FILE_SYNC;
346}
347#else /* CONFIG_NFS_v4_1 */
348static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
349{
350 return NULL;
351}
352
353static inline bool
354is_ds_only_client(struct nfs_client *clp)
355{
356 return false;
357}
358
359static inline bool
360is_ds_client(struct nfs_client *clp)
361{
362 return false;
363}
364
365static inline void
366nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
367 struct rpc_clnt **clntp, struct rpc_message *msg)
368{
369}
370
371static inline void
372nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
373 struct rpc_message *msg, struct nfs_pgio_header *hdr)
374{
375}
376#endif /* CONFIG_NFS_V4_1 */
377
378extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
379
380extern const u32 nfs4_fattr_bitmap[3];
381extern const u32 nfs4_statfs_bitmap[3];
382extern const u32 nfs4_pathconf_bitmap[3];
383extern const u32 nfs4_fsinfo_bitmap[3];
384extern const u32 nfs4_fs_locations_bitmap[3];
385
386void nfs40_shutdown_client(struct nfs_client *);
387void nfs41_shutdown_client(struct nfs_client *);
388int nfs40_init_client(struct nfs_client *);
389int nfs41_init_client(struct nfs_client *);
390void nfs4_free_client(struct nfs_client *);
391
392struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
393
394/* nfs4renewd.c */
395extern void nfs4_schedule_state_renewal(struct nfs_client *);
396extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
397extern void nfs4_kill_renewd(struct nfs_client *);
398extern void nfs4_renew_state(struct work_struct *);
399extern void nfs4_set_lease_period(struct nfs_client *clp,
400 unsigned long lease,
401 unsigned long lastrenewed);
402
403
404/* nfs4state.c */
405struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
406struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
407struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
408int nfs4_discover_server_trunking(struct nfs_client *clp,
409 struct nfs_client **);
410int nfs40_discover_server_trunking(struct nfs_client *clp,
411 struct nfs_client **, struct rpc_cred *);
412#if defined(CONFIG_NFS_V4_1)
413int nfs41_discover_server_trunking(struct nfs_client *clp,
414 struct nfs_client **, struct rpc_cred *);
415extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
416extern void nfs41_notify_server(struct nfs_client *);
417#else
418static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
419{
420}
421#endif /* CONFIG_NFS_V4_1 */
422
423extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
424extern void nfs4_put_state_owner(struct nfs4_state_owner *);
425extern void nfs4_purge_state_owners(struct nfs_server *);
426extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
427extern void nfs4_put_open_state(struct nfs4_state *);
428extern void nfs4_close_state(struct nfs4_state *, fmode_t);
429extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
430extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
431extern void nfs_inode_find_state_and_recover(struct inode *inode,
432 const nfs4_stateid *stateid);
433extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
434extern void nfs4_schedule_lease_recovery(struct nfs_client *);
435extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
436extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
437extern void nfs4_schedule_state_manager(struct nfs_client *);
438extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
439extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
440extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
441extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
442extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
443extern void nfs41_handle_server_scope(struct nfs_client *,
444 struct nfs41_server_scope **);
445extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
446extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
447extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
448 const struct nfs_lockowner *, nfs4_stateid *,
449 struct rpc_cred **);
450
451extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
452extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
453extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
454extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
455extern void nfs_release_seqid(struct nfs_seqid *seqid);
456extern void nfs_free_seqid(struct nfs_seqid *seqid);
457extern int nfs40_setup_sequence(struct nfs4_slot_table *tbl,
458 struct nfs4_sequence_args *args,
459 struct nfs4_sequence_res *res,
460 struct rpc_task *task);
461extern int nfs4_sequence_done(struct rpc_task *task,
462 struct nfs4_sequence_res *res);
463
464extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
465
466extern const nfs4_stateid zero_stateid;
467
468/* nfs4super.c */
469struct nfs_mount_info;
470extern struct nfs_subversion nfs_v4;
471struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
472extern bool nfs4_disable_idmapping;
473extern unsigned short max_session_slots;
474extern unsigned short send_implementation_id;
475extern bool recover_lost_locks;
476
477#define NFS4_CLIENT_ID_UNIQ_LEN (64)
478extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
479
480/* nfs4sysctl.c */
481#ifdef CONFIG_SYSCTL
482int nfs4_register_sysctl(void);
483void nfs4_unregister_sysctl(void);
484#else
485static inline int nfs4_register_sysctl(void)
486{
487 return 0;
488}
489
490static inline void nfs4_unregister_sysctl(void)
491{
492}
493#endif
494
495/* nfs4xdr.c */
496extern struct rpc_procinfo nfs4_procedures[];
497
498struct nfs4_mount_data;
499
500/* callback_xdr.c */
501extern struct svc_version nfs4_callback_version1;
502extern struct svc_version nfs4_callback_version4;
503
504static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
505{
506 memcpy(dst->data, src->data, sizeof(dst->data));
507 dst->type = src->type;
508}
509
510static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
511{
512 if (dst->type != src->type)
513 return false;
514 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
515}
516
517static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
518{
519 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
520}
521
522static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
523{
524 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
525}
526
527static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
528{
529 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
530}
531
532#else
533
534#define nfs4_close_state(a, b) do { } while (0)
535#define nfs4_close_sync(a, b) do { } while (0)
536#define nfs4_state_protect(a, b, c, d) do { } while (0)
537#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
538
539#endif /* CONFIG_NFS_V4 */
540#endif /* __LINUX_FS_NFS_NFS4_FS.H */