tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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#ifdef CONFIG_NFS_V4
13
14struct idmap;
15
16enum nfs4_client_state {
17 NFS4CLNT_MANAGER_RUNNING = 0,
18 NFS4CLNT_CHECK_LEASE,
19 NFS4CLNT_LEASE_EXPIRED,
20 NFS4CLNT_RECLAIM_REBOOT,
21 NFS4CLNT_RECLAIM_NOGRACE,
22 NFS4CLNT_DELEGRETURN,
23 NFS4CLNT_LAYOUTRECALL,
24 NFS4CLNT_SESSION_RESET,
25 NFS4CLNT_RECALL_SLOT,
26 NFS4CLNT_LEASE_CONFIRM,
27 NFS4CLNT_SERVER_SCOPE_MISMATCH,
28};
29
30enum nfs4_session_state {
31 NFS4_SESSION_INITING,
32 NFS4_SESSION_DRAINING,
33};
34
35#define NFS4_RENEW_TIMEOUT 0x01
36#define NFS4_RENEW_DELEGATION_CB 0x02
37
38struct nfs4_minor_version_ops {
39 u32 minor_version;
40
41 int (*call_sync)(struct rpc_clnt *clnt,
42 struct nfs_server *server,
43 struct rpc_message *msg,
44 struct nfs4_sequence_args *args,
45 struct nfs4_sequence_res *res,
46 int cache_reply);
47 int (*validate_stateid)(struct nfs_delegation *,
48 const nfs4_stateid *);
49 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
50 struct nfs_fsinfo *);
51 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
52 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
53 const struct nfs4_state_maintenance_ops *state_renewal_ops;
54};
55
56/*
57 * struct rpc_sequence ensures that RPC calls are sent in the exact
58 * order that they appear on the list.
59 */
60struct rpc_sequence {
61 struct rpc_wait_queue wait; /* RPC call delay queue */
62 spinlock_t lock; /* Protects the list */
63 struct list_head list; /* Defines sequence of RPC calls */
64};
65
66#define NFS_SEQID_CONFIRMED 1
67struct nfs_seqid_counter {
68 struct rpc_sequence *sequence;
69 int flags;
70 u32 counter;
71};
72
73struct nfs_seqid {
74 struct nfs_seqid_counter *sequence;
75 struct list_head list;
76};
77
78static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
79{
80 if (seqid_mutating_err(-status))
81 seqid->flags |= NFS_SEQID_CONFIRMED;
82}
83
84struct nfs_unique_id {
85 struct rb_node rb_node;
86 __u64 id;
87};
88
89/*
90 * NFS4 state_owners and lock_owners are simply labels for ordered
91 * sequences of RPC calls. Their sole purpose is to provide once-only
92 * semantics by allowing the server to identify replayed requests.
93 */
94struct nfs4_state_owner {
95 struct nfs_unique_id so_owner_id;
96 struct nfs_server *so_server;
97 struct rb_node so_server_node;
98
99 struct rpc_cred *so_cred; /* Associated cred */
100
101 spinlock_t so_lock;
102 atomic_t so_count;
103 unsigned long so_flags;
104 struct list_head so_states;
105 struct nfs_seqid_counter so_seqid;
106 struct rpc_sequence so_sequence;
107};
108
109enum {
110 NFS_OWNER_RECLAIM_REBOOT,
111 NFS_OWNER_RECLAIM_NOGRACE
112};
113
114#define NFS_LOCK_NEW 0
115#define NFS_LOCK_RECLAIM 1
116#define NFS_LOCK_EXPIRED 2
117
118/*
119 * struct nfs4_state maintains the client-side state for a given
120 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
121 *
122 * OPEN:
123 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
124 * we need to know how many files are open for reading or writing on a
125 * given inode. This information too is stored here.
126 *
127 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
128 */
129
130struct nfs4_lock_owner {
131 unsigned int lo_type;
132#define NFS4_ANY_LOCK_TYPE (0U)
133#define NFS4_FLOCK_LOCK_TYPE (1U << 0)
134#define NFS4_POSIX_LOCK_TYPE (1U << 1)
135 union {
136 fl_owner_t posix_owner;
137 pid_t flock_owner;
138 } lo_u;
139};
140
141struct nfs4_lock_state {
142 struct list_head ls_locks; /* Other lock stateids */
143 struct nfs4_state * ls_state; /* Pointer to open state */
144#define NFS_LOCK_INITIALIZED 1
145 int ls_flags;
146 struct nfs_seqid_counter ls_seqid;
147 struct rpc_sequence ls_sequence;
148 struct nfs_unique_id ls_id;
149 nfs4_stateid ls_stateid;
150 atomic_t ls_count;
151 struct nfs4_lock_owner ls_owner;
152};
153
154/* bits for nfs4_state->flags */
155enum {
156 LK_STATE_IN_USE,
157 NFS_DELEGATED_STATE, /* Current stateid is delegation */
158 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
159 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
160 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
161 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
162 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
163 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
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 long timeout;
192 int retry;
193 struct nfs4_state *state;
194};
195
196struct nfs4_state_recovery_ops {
197 int owner_flag_bit;
198 int state_flag_bit;
199 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
200 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
201 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
202 struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
203 int (*reclaim_complete)(struct nfs_client *);
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
212extern const struct dentry_operations nfs4_dentry_operations;
213extern const struct inode_operations nfs4_dir_inode_operations;
214
215/* nfs4proc.c */
216extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
217extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
218extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
219extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
220extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
221extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
222extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
223extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
224 struct nfs4_fs_locations *fs_locations, struct page *page);
225extern void nfs4_release_lockowner(const struct nfs4_lock_state *);
226extern const struct xattr_handler *nfs4_xattr_handlers[];
227
228#if defined(CONFIG_NFS_V4_1)
229static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
230{
231 return server->nfs_client->cl_session;
232}
233
234extern int nfs4_setup_sequence(const struct nfs_server *server,
235 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
236 int cache_reply, struct rpc_task *task);
237extern int nfs41_setup_sequence(struct nfs4_session *session,
238 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
239 int cache_reply, struct rpc_task *task);
240extern void nfs4_destroy_session(struct nfs4_session *session);
241extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
242extern int nfs4_proc_create_session(struct nfs_client *);
243extern int nfs4_proc_destroy_session(struct nfs4_session *);
244extern int nfs4_init_session(struct nfs_server *server);
245extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
246 struct nfs_fsinfo *fsinfo);
247extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
248 bool sync);
249
250static inline bool
251is_ds_only_client(struct nfs_client *clp)
252{
253 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
254 EXCHGID4_FLAG_USE_PNFS_DS;
255}
256
257static inline bool
258is_ds_client(struct nfs_client *clp)
259{
260 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
261}
262#else /* CONFIG_NFS_v4_1 */
263static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
264{
265 return NULL;
266}
267
268static inline int nfs4_setup_sequence(const struct nfs_server *server,
269 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
270 int cache_reply, struct rpc_task *task)
271{
272 return 0;
273}
274
275static inline int nfs4_init_session(struct nfs_server *server)
276{
277 return 0;
278}
279
280static inline bool
281is_ds_only_client(struct nfs_client *clp)
282{
283 return false;
284}
285
286static inline bool
287is_ds_client(struct nfs_client *clp)
288{
289 return false;
290}
291#endif /* CONFIG_NFS_V4_1 */
292
293extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
294
295extern const u32 nfs4_fattr_bitmap[2];
296extern const u32 nfs4_statfs_bitmap[2];
297extern const u32 nfs4_pathconf_bitmap[2];
298extern const u32 nfs4_fsinfo_bitmap[3];
299extern const u32 nfs4_fs_locations_bitmap[2];
300
301/* nfs4renewd.c */
302extern void nfs4_schedule_state_renewal(struct nfs_client *);
303extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
304extern void nfs4_kill_renewd(struct nfs_client *);
305extern void nfs4_renew_state(struct work_struct *);
306
307/* nfs4state.c */
308struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
309struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
310#if defined(CONFIG_NFS_V4_1)
311struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
312struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
313extern void nfs4_schedule_session_recovery(struct nfs4_session *);
314#else
315static inline void nfs4_schedule_session_recovery(struct nfs4_session *session)
316{
317}
318#endif /* CONFIG_NFS_V4_1 */
319
320extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
321extern void nfs4_put_state_owner(struct nfs4_state_owner *);
322extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
323extern void nfs4_put_open_state(struct nfs4_state *);
324extern void nfs4_close_state(struct nfs4_state *, fmode_t);
325extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
326extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
327extern void nfs4_schedule_lease_recovery(struct nfs_client *);
328extern void nfs4_schedule_state_manager(struct nfs_client *);
329extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
330extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
331extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
332extern void nfs41_handle_recall_slot(struct nfs_client *clp);
333extern void nfs41_handle_server_scope(struct nfs_client *,
334 struct server_scope **);
335extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
336extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
337extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t, pid_t);
338
339extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
340extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
341extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
342extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
343extern void nfs_release_seqid(struct nfs_seqid *seqid);
344extern void nfs_free_seqid(struct nfs_seqid *seqid);
345
346extern const nfs4_stateid zero_stateid;
347
348/* nfs4xdr.c */
349extern struct rpc_procinfo nfs4_procedures[];
350
351struct nfs4_mount_data;
352
353/* callback_xdr.c */
354extern struct svc_version nfs4_callback_version1;
355extern struct svc_version nfs4_callback_version4;
356
357#else
358
359#define nfs4_close_state(a, b) do { } while (0)
360#define nfs4_close_sync(a, b) do { } while (0)
361
362#endif /* CONFIG_NFS_V4 */
363#endif /* __LINUX_FS_NFS_NFS4_FS.H */