NFSv4: Fail I/O if the state recovery fails irrevocably
[linux-2.6-block.git] / 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 IS_ENABLED(CONFIG_NFS_V4)
13
14 #define NFS4_MAX_LOOP_ON_RECOVER (10)
15
16 #include <linux/seqlock.h>
17
18 struct idmap;
19
20 enum nfs4_client_state {
21         NFS4CLNT_MANAGER_RUNNING  = 0,
22         NFS4CLNT_CHECK_LEASE,
23         NFS4CLNT_LEASE_EXPIRED,
24         NFS4CLNT_RECLAIM_REBOOT,
25         NFS4CLNT_RECLAIM_NOGRACE,
26         NFS4CLNT_DELEGRETURN,
27         NFS4CLNT_SESSION_RESET,
28         NFS4CLNT_LEASE_CONFIRM,
29         NFS4CLNT_SERVER_SCOPE_MISMATCH,
30         NFS4CLNT_PURGE_STATE,
31         NFS4CLNT_BIND_CONN_TO_SESSION,
32 };
33
34 #define NFS4_RENEW_TIMEOUT              0x01
35 #define NFS4_RENEW_DELEGATION_CB        0x02
36
37 struct nfs4_minor_version_ops {
38         u32     minor_version;
39
40         int     (*call_sync)(struct rpc_clnt *clnt,
41                         struct nfs_server *server,
42                         struct rpc_message *msg,
43                         struct nfs4_sequence_args *args,
44                         struct nfs4_sequence_res *res);
45         bool    (*match_stateid)(const nfs4_stateid *,
46                         const nfs4_stateid *);
47         int     (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
48                         struct nfs_fsinfo *);
49         const struct nfs4_state_recovery_ops *reboot_recovery_ops;
50         const struct nfs4_state_recovery_ops *nograce_recovery_ops;
51         const struct nfs4_state_maintenance_ops *state_renewal_ops;
52 };
53
54 #define NFS_SEQID_CONFIRMED 1
55 struct nfs_seqid_counter {
56         ktime_t create_time;
57         int owner_id;
58         int flags;
59         u32 counter;
60         spinlock_t lock;                /* Protects the list */
61         struct list_head list;          /* Defines sequence of RPC calls */
62         struct rpc_wait_queue   wait;   /* RPC call delay queue */
63 };
64
65 struct nfs_seqid {
66         struct nfs_seqid_counter *sequence;
67         struct list_head list;
68         struct rpc_task *task;
69 };
70
71 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
72 {
73         if (seqid_mutating_err(-status))
74                 seqid->flags |= NFS_SEQID_CONFIRMED;
75 }
76
77 /*
78  * NFS4 state_owners and lock_owners are simply labels for ordered
79  * sequences of RPC calls. Their sole purpose is to provide once-only
80  * semantics by allowing the server to identify replayed requests.
81  */
82 struct nfs4_state_owner {
83         struct nfs_server    *so_server;
84         struct list_head     so_lru;
85         unsigned long        so_expires;
86         struct rb_node       so_server_node;
87
88         struct rpc_cred      *so_cred;   /* Associated cred */
89
90         spinlock_t           so_lock;
91         atomic_t             so_count;
92         unsigned long        so_flags;
93         struct list_head     so_states;
94         struct nfs_seqid_counter so_seqid;
95         seqcount_t           so_reclaim_seqcount;
96         struct mutex         so_delegreturn_mutex;
97 };
98
99 enum {
100         NFS_OWNER_RECLAIM_REBOOT,
101         NFS_OWNER_RECLAIM_NOGRACE
102 };
103
104 #define NFS_LOCK_NEW            0
105 #define NFS_LOCK_RECLAIM        1
106 #define NFS_LOCK_EXPIRED        2
107
108 /*
109  * struct nfs4_state maintains the client-side state for a given
110  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
111  *
112  * OPEN:
113  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
114  * we need to know how many files are open for reading or writing on a
115  * given inode. This information too is stored here.
116  *
117  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
118  */
119
120 struct nfs4_lock_owner {
121         unsigned int lo_type;
122 #define NFS4_ANY_LOCK_TYPE      (0U)
123 #define NFS4_FLOCK_LOCK_TYPE    (1U << 0)
124 #define NFS4_POSIX_LOCK_TYPE    (1U << 1)
125         union {
126                 fl_owner_t posix_owner;
127                 pid_t flock_owner;
128         } lo_u;
129 };
130
131 struct nfs4_lock_state {
132         struct list_head        ls_locks;       /* Other lock stateids */
133         struct nfs4_state *     ls_state;       /* Pointer to open state */
134 #define NFS_LOCK_INITIALIZED 0
135         unsigned long           ls_flags;
136         struct nfs_seqid_counter        ls_seqid;
137         nfs4_stateid            ls_stateid;
138         atomic_t                ls_count;
139         struct nfs4_lock_owner  ls_owner;
140 };
141
142 /* bits for nfs4_state->flags */
143 enum {
144         LK_STATE_IN_USE,
145         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
146         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
147         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
148         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
149         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
150         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
151         NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
152         NFS_STATE_RECOVERY_FAILED,      /* OPEN stateid state recovery failed */
153 };
154
155 struct nfs4_state {
156         struct list_head open_states;   /* List of states for the same state_owner */
157         struct list_head inode_states;  /* List of states for the same inode */
158         struct list_head lock_states;   /* List of subservient lock stateids */
159
160         struct nfs4_state_owner *owner; /* Pointer to the open owner */
161         struct inode *inode;            /* Pointer to the inode */
162
163         unsigned long flags;            /* Do we hold any locks? */
164         spinlock_t state_lock;          /* Protects the lock_states list */
165
166         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
167         nfs4_stateid stateid;           /* Current stateid: may be delegation */
168         nfs4_stateid open_stateid;      /* OPEN stateid */
169
170         /* The following 3 fields are protected by owner->so_lock */
171         unsigned int n_rdonly;          /* Number of read-only references */
172         unsigned int n_wronly;          /* Number of write-only references */
173         unsigned int n_rdwr;            /* Number of read/write references */
174         fmode_t state;                  /* State on the server (R,W, or RW) */
175         atomic_t count;
176 };
177
178
179 struct nfs4_exception {
180         long timeout;
181         int retry;
182         struct nfs4_state *state;
183         struct inode *inode;
184 };
185
186 struct nfs4_state_recovery_ops {
187         int owner_flag_bit;
188         int state_flag_bit;
189         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
190         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
191         int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
192         struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
193         int (*reclaim_complete)(struct nfs_client *);
194         int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
195                 struct rpc_cred *);
196 };
197
198 struct nfs4_state_maintenance_ops {
199         int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
200         struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
201         int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
202 };
203
204 extern const struct dentry_operations nfs4_dentry_operations;
205
206 /* dir.c */
207 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
208                     unsigned, umode_t, int *);
209
210 /* super.c */
211 extern struct file_system_type nfs4_fs_type;
212
213 /* nfs4namespace.c */
214 rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
215 struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
216 struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
217                                struct nfs_fh *, struct nfs_fattr *);
218
219 /* nfs4proc.c */
220 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
221 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
222 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *);
223 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
224 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
225 extern int nfs4_destroy_clientid(struct nfs_client *clp);
226 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
227 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
228 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
229 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
230 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
231                                   struct nfs4_fs_locations *, struct page *);
232 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
233                             struct nfs_fh *, struct nfs_fattr *);
234 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
235 extern int nfs4_release_lockowner(struct nfs4_lock_state *);
236 extern const struct xattr_handler *nfs4_xattr_handlers[];
237
238 #if defined(CONFIG_NFS_V4_1)
239 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
240 {
241         return server->nfs_client->cl_session;
242 }
243
244 extern int nfs4_setup_sequence(const struct nfs_server *server,
245                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
246                 struct rpc_task *task);
247 extern int nfs41_setup_sequence(struct nfs4_session *session,
248                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
249                 struct rpc_task *task);
250 extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
251 extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
252 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
253                 struct nfs_fsinfo *fsinfo);
254 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
255                                   bool sync);
256
257 static inline bool
258 is_ds_only_client(struct nfs_client *clp)
259 {
260         return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
261                 EXCHGID4_FLAG_USE_PNFS_DS;
262 }
263
264 static inline bool
265 is_ds_client(struct nfs_client *clp)
266 {
267         return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
268 }
269 #else /* CONFIG_NFS_v4_1 */
270 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
271 {
272         return NULL;
273 }
274
275 static inline int nfs4_setup_sequence(const struct nfs_server *server,
276                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
277                 struct rpc_task *task)
278 {
279         rpc_call_start(task);
280         return 0;
281 }
282
283 static inline bool
284 is_ds_only_client(struct nfs_client *clp)
285 {
286         return false;
287 }
288
289 static inline bool
290 is_ds_client(struct nfs_client *clp)
291 {
292         return false;
293 }
294 #endif /* CONFIG_NFS_V4_1 */
295
296 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
297
298 extern const u32 nfs4_fattr_bitmap[3];
299 extern const u32 nfs4_statfs_bitmap[2];
300 extern const u32 nfs4_pathconf_bitmap[2];
301 extern const u32 nfs4_fsinfo_bitmap[3];
302 extern const u32 nfs4_fs_locations_bitmap[2];
303
304 void nfs4_free_client(struct nfs_client *);
305
306 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
307
308 /* nfs4renewd.c */
309 extern void nfs4_schedule_state_renewal(struct nfs_client *);
310 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
311 extern void nfs4_kill_renewd(struct nfs_client *);
312 extern void nfs4_renew_state(struct work_struct *);
313
314 /* nfs4state.c */
315 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
316 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
317 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
318 int nfs4_discover_server_trunking(struct nfs_client *clp,
319                         struct nfs_client **);
320 int nfs40_discover_server_trunking(struct nfs_client *clp,
321                         struct nfs_client **, struct rpc_cred *);
322 #if defined(CONFIG_NFS_V4_1)
323 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
324 int nfs41_discover_server_trunking(struct nfs_client *clp,
325                         struct nfs_client **, struct rpc_cred *);
326 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
327 extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
328 extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);
329
330 #else
331 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
332 {
333 }
334 #endif /* CONFIG_NFS_V4_1 */
335
336 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
337 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
338 extern void nfs4_purge_state_owners(struct nfs_server *);
339 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
340 extern void nfs4_put_open_state(struct nfs4_state *);
341 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
342 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
343 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
344 extern void nfs_inode_find_state_and_recover(struct inode *inode,
345                 const nfs4_stateid *stateid);
346 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
347 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
348 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
349 extern void nfs4_schedule_state_manager(struct nfs_client *);
350 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
351 extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
352 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
353 extern void nfs41_handle_server_scope(struct nfs_client *,
354                                       struct nfs41_server_scope **);
355 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
356 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
357 extern void nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
358                 fmode_t, const struct nfs_lockowner *);
359
360 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
361 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
362 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
363 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
364 extern void nfs_release_seqid(struct nfs_seqid *seqid);
365 extern void nfs_free_seqid(struct nfs_seqid *seqid);
366
367 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
368
369 extern const nfs4_stateid zero_stateid;
370
371 /* nfs4super.c */
372 struct nfs_mount_info;
373 extern struct nfs_subversion nfs_v4;
374 struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
375 extern bool nfs4_disable_idmapping;
376 extern unsigned short max_session_slots;
377 extern unsigned short send_implementation_id;
378
379 #define NFS4_CLIENT_ID_UNIQ_LEN         (64)
380 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
381
382 /* nfs4sysctl.c */
383 #ifdef CONFIG_SYSCTL
384 int nfs4_register_sysctl(void);
385 void nfs4_unregister_sysctl(void);
386 #else
387 static inline int nfs4_register_sysctl(void)
388 {
389         return 0;
390 }
391
392 static inline void nfs4_unregister_sysctl(void)
393 {
394 }
395 #endif
396
397 /* nfs4xdr.c */
398 extern struct rpc_procinfo nfs4_procedures[];
399
400 struct nfs4_mount_data;
401
402 /* callback_xdr.c */
403 extern struct svc_version nfs4_callback_version1;
404 extern struct svc_version nfs4_callback_version4;
405
406 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
407 {
408         memcpy(dst, src, sizeof(*dst));
409 }
410
411 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
412 {
413         return memcmp(dst, src, sizeof(*dst)) == 0;
414 }
415
416 static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
417 {
418         return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
419 }
420
421 #else
422
423 #define nfs4_close_state(a, b) do { } while (0)
424 #define nfs4_close_sync(a, b) do { } while (0)
425
426 #endif /* CONFIG_NFS_V4 */
427 #endif /* __LINUX_FS_NFS_NFS4_FS.H */