2 * linux/fs/nfs/nfs4_fs.h
4 * Copyright (C) 2005 Trond Myklebust
6 * NFSv4-specific filesystem definitions and declarations
9 #ifndef __LINUX_FS_NFS_NFS4_FS_H
10 #define __LINUX_FS_NFS_NFS4_FS_H
12 #if IS_ENABLED(CONFIG_NFS_V4)
14 #define NFS4_MAX_LOOP_ON_RECOVER (10)
18 enum nfs4_client_state {
19 NFS4CLNT_MANAGER_RUNNING = 0,
21 NFS4CLNT_LEASE_EXPIRED,
22 NFS4CLNT_RECLAIM_REBOOT,
23 NFS4CLNT_RECLAIM_NOGRACE,
25 NFS4CLNT_SESSION_RESET,
26 NFS4CLNT_LEASE_CONFIRM,
27 NFS4CLNT_SERVER_SCOPE_MISMATCH,
29 NFS4CLNT_BIND_CONN_TO_SESSION,
32 #define NFS4_RENEW_TIMEOUT 0x01
33 #define NFS4_RENEW_DELEGATION_CB 0x02
35 struct nfs4_minor_version_ops {
38 int (*call_sync)(struct rpc_clnt *clnt,
39 struct nfs_server *server,
40 struct rpc_message *msg,
41 struct nfs4_sequence_args *args,
42 struct nfs4_sequence_res *res,
44 bool (*match_stateid)(const nfs4_stateid *,
45 const nfs4_stateid *);
46 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
48 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
49 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
50 const struct nfs4_state_maintenance_ops *state_renewal_ops;
53 #define NFS_SEQID_CONFIRMED 1
54 struct nfs_seqid_counter {
59 spinlock_t lock; /* Protects the list */
60 struct list_head list; /* Defines sequence of RPC calls */
61 struct rpc_wait_queue wait; /* RPC call delay queue */
65 struct nfs_seqid_counter *sequence;
66 struct list_head list;
67 struct rpc_task *task;
70 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
72 if (seqid_mutating_err(-status))
73 seqid->flags |= NFS_SEQID_CONFIRMED;
77 * NFS4 state_owners and lock_owners are simply labels for ordered
78 * sequences of RPC calls. Their sole purpose is to provide once-only
79 * semantics by allowing the server to identify replayed requests.
81 struct nfs4_state_owner {
82 struct nfs_server *so_server;
83 struct list_head so_lru;
84 unsigned long so_expires;
85 struct rb_node so_server_node;
87 struct rpc_cred *so_cred; /* Associated cred */
91 unsigned long so_flags;
92 struct list_head so_states;
93 struct nfs_seqid_counter so_seqid;
97 NFS_OWNER_RECLAIM_REBOOT,
98 NFS_OWNER_RECLAIM_NOGRACE
101 #define NFS_LOCK_NEW 0
102 #define NFS_LOCK_RECLAIM 1
103 #define NFS_LOCK_EXPIRED 2
106 * struct nfs4_state maintains the client-side state for a given
107 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
110 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
111 * we need to know how many files are open for reading or writing on a
112 * given inode. This information too is stored here.
114 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
117 struct nfs4_lock_owner {
118 unsigned int lo_type;
119 #define NFS4_ANY_LOCK_TYPE (0U)
120 #define NFS4_FLOCK_LOCK_TYPE (1U << 0)
121 #define NFS4_POSIX_LOCK_TYPE (1U << 1)
123 fl_owner_t posix_owner;
128 struct nfs4_lock_state {
129 struct list_head ls_locks; /* Other lock stateids */
130 struct nfs4_state * ls_state; /* Pointer to open state */
131 #define NFS_LOCK_INITIALIZED 0
132 unsigned long ls_flags;
133 struct nfs_seqid_counter ls_seqid;
134 nfs4_stateid ls_stateid;
136 struct nfs4_lock_owner ls_owner;
139 /* bits for nfs4_state->flags */
142 NFS_DELEGATED_STATE, /* Current stateid is delegation */
143 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
144 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
145 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
146 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
147 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
148 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
152 struct list_head open_states; /* List of states for the same state_owner */
153 struct list_head inode_states; /* List of states for the same inode */
154 struct list_head lock_states; /* List of subservient lock stateids */
156 struct nfs4_state_owner *owner; /* Pointer to the open owner */
157 struct inode *inode; /* Pointer to the inode */
159 unsigned long flags; /* Do we hold any locks? */
160 spinlock_t state_lock; /* Protects the lock_states list */
162 seqlock_t seqlock; /* Protects the stateid/open_stateid */
163 nfs4_stateid stateid; /* Current stateid: may be delegation */
164 nfs4_stateid open_stateid; /* OPEN stateid */
166 /* The following 3 fields are protected by owner->so_lock */
167 unsigned int n_rdonly; /* Number of read-only references */
168 unsigned int n_wronly; /* Number of write-only references */
169 unsigned int n_rdwr; /* Number of read/write references */
170 fmode_t state; /* State on the server (R,W, or RW) */
175 struct nfs4_exception {
178 struct nfs4_state *state;
182 struct nfs4_state_recovery_ops {
185 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
186 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
187 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
188 struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
189 int (*reclaim_complete)(struct nfs_client *);
190 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
194 struct nfs4_state_maintenance_ops {
195 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
196 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
197 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
200 extern const struct dentry_operations nfs4_dentry_operations;
203 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
204 unsigned, umode_t, int *);
207 extern struct file_system_type nfs4_fs_type;
209 /* nfs4namespace.c */
210 rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
211 struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
212 struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
213 struct nfs_fh *, struct nfs_fattr *);
216 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
217 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
218 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *);
219 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
220 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
221 extern int nfs4_destroy_clientid(struct nfs_client *clp);
222 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
223 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
224 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
225 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
226 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
227 struct nfs4_fs_locations *, struct page *);
228 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
229 struct nfs_fh *, struct nfs_fattr *);
230 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
231 extern int nfs4_release_lockowner(struct nfs4_lock_state *);
232 extern const struct xattr_handler *nfs4_xattr_handlers[];
234 #if defined(CONFIG_NFS_V4_1)
235 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
237 return server->nfs_client->cl_session;
240 extern bool nfs4_set_task_privileged(struct rpc_task *task, void *dummy);
241 extern int nfs4_setup_sequence(const struct nfs_server *server,
242 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
243 struct rpc_task *task);
244 extern int nfs41_setup_sequence(struct nfs4_session *session,
245 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
246 struct rpc_task *task);
247 extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
248 extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
249 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
250 struct nfs_fsinfo *fsinfo);
251 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
255 is_ds_only_client(struct nfs_client *clp)
257 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
258 EXCHGID4_FLAG_USE_PNFS_DS;
262 is_ds_client(struct nfs_client *clp)
264 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
266 #else /* CONFIG_NFS_v4_1 */
267 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
272 static inline int nfs4_setup_sequence(const struct nfs_server *server,
273 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
274 struct rpc_task *task)
280 is_ds_only_client(struct nfs_client *clp)
286 is_ds_client(struct nfs_client *clp)
290 #endif /* CONFIG_NFS_V4_1 */
292 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
294 extern const u32 nfs4_fattr_bitmap[3];
295 extern const u32 nfs4_statfs_bitmap[2];
296 extern const u32 nfs4_pathconf_bitmap[2];
297 extern const u32 nfs4_fsinfo_bitmap[3];
298 extern const u32 nfs4_fs_locations_bitmap[2];
300 void nfs4_free_client(struct nfs_client *);
302 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
305 extern void nfs4_schedule_state_renewal(struct nfs_client *);
306 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
307 extern void nfs4_kill_renewd(struct nfs_client *);
308 extern void nfs4_renew_state(struct work_struct *);
311 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
312 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
313 int nfs4_discover_server_trunking(struct nfs_client *clp,
314 struct nfs_client **);
315 int nfs40_discover_server_trunking(struct nfs_client *clp,
316 struct nfs_client **, struct rpc_cred *);
317 #if defined(CONFIG_NFS_V4_1)
318 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
319 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
320 int nfs41_discover_server_trunking(struct nfs_client *clp,
321 struct nfs_client **, struct rpc_cred *);
322 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
323 extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
324 extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);
327 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
330 #endif /* CONFIG_NFS_V4_1 */
332 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
333 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
334 extern void nfs4_purge_state_owners(struct nfs_server *);
335 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
336 extern void nfs4_put_open_state(struct nfs4_state *);
337 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
338 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
339 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
340 extern void nfs_inode_find_state_and_recover(struct inode *inode,
341 const nfs4_stateid *stateid);
342 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
343 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
344 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
345 extern void nfs4_schedule_state_manager(struct nfs_client *);
346 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
347 extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
348 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
349 extern void nfs41_handle_server_scope(struct nfs_client *,
350 struct nfs41_server_scope **);
351 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
352 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
353 extern void nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
354 fmode_t, const struct nfs_lockowner *);
356 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
357 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
358 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
359 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
360 extern void nfs_release_seqid(struct nfs_seqid *seqid);
361 extern void nfs_free_seqid(struct nfs_seqid *seqid);
363 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
365 extern const nfs4_stateid zero_stateid;
368 struct nfs_mount_info;
369 extern struct nfs_subversion nfs_v4;
370 struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
371 extern bool nfs4_disable_idmapping;
372 extern unsigned short max_session_slots;
373 extern unsigned short send_implementation_id;
375 #define NFS4_CLIENT_ID_UNIQ_LEN (64)
376 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
380 int nfs4_register_sysctl(void);
381 void nfs4_unregister_sysctl(void);
383 static inline int nfs4_register_sysctl(void)
388 static inline void nfs4_unregister_sysctl(void)
394 extern struct rpc_procinfo nfs4_procedures[];
396 struct nfs4_mount_data;
399 extern struct svc_version nfs4_callback_version1;
400 extern struct svc_version nfs4_callback_version4;
402 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
404 memcpy(dst, src, sizeof(*dst));
407 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
409 return memcmp(dst, src, sizeof(*dst)) == 0;
414 #define nfs4_close_state(a, b) do { } while (0)
415 #define nfs4_close_sync(a, b) do { } while (0)
417 #endif /* CONFIG_NFS_V4 */
418 #endif /* __LINUX_FS_NFS_NFS4_FS.H */