Commit | Line | Data |
---|---|---|
4ce79717 TM |
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 | ||
14 | struct idmap; | |
15 | ||
16 | /* | |
17 | * In a seqid-mutating op, this macro controls which error return | |
18 | * values trigger incrementation of the seqid. | |
19 | * | |
20 | * from rfc 3010: | |
21 | * The client MUST monotonically increment the sequence number for the | |
22 | * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE | |
23 | * operations. This is true even in the event that the previous | |
24 | * operation that used the sequence number received an error. The only | |
25 | * exception to this rule is if the previous operation received one of | |
26 | * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID, | |
27 | * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR, | |
28 | * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE. | |
29 | * | |
30 | */ | |
31 | #define seqid_mutating_err(err) \ | |
32 | (((err) != NFSERR_STALE_CLIENTID) && \ | |
33 | ((err) != NFSERR_STALE_STATEID) && \ | |
34 | ((err) != NFSERR_BAD_STATEID) && \ | |
35 | ((err) != NFSERR_BAD_SEQID) && \ | |
36 | ((err) != NFSERR_BAD_XDR) && \ | |
37 | ((err) != NFSERR_RESOURCE) && \ | |
38 | ((err) != NFSERR_NOFILEHANDLE)) | |
39 | ||
40 | enum nfs4_client_state { | |
e005e804 | 41 | NFS4CLNT_MANAGER_RUNNING = 0, |
e598d843 | 42 | NFS4CLNT_CHECK_LEASE, |
58d9714a | 43 | NFS4CLNT_LEASE_EXPIRED, |
b79a4a1b TM |
44 | NFS4CLNT_RECLAIM_REBOOT, |
45 | NFS4CLNT_RECLAIM_NOGRACE, | |
707fb4b3 | 46 | NFS4CLNT_DELEGRETURN, |
6df08189 | 47 | NFS4CLNT_SESSION_RESET, |
ea028ac9 | 48 | NFS4CLNT_SESSION_DRAINING, |
4ce79717 TM |
49 | }; |
50 | ||
cee54fc9 TM |
51 | /* |
52 | * struct rpc_sequence ensures that RPC calls are sent in the exact | |
53 | * order that they appear on the list. | |
54 | */ | |
55 | struct rpc_sequence { | |
56 | struct rpc_wait_queue wait; /* RPC call delay queue */ | |
57 | spinlock_t lock; /* Protects the list */ | |
58 | struct list_head list; /* Defines sequence of RPC calls */ | |
59 | }; | |
60 | ||
61 | #define NFS_SEQID_CONFIRMED 1 | |
62 | struct nfs_seqid_counter { | |
63 | struct rpc_sequence *sequence; | |
64 | int flags; | |
65 | u32 counter; | |
66 | }; | |
67 | ||
68 | struct nfs_seqid { | |
cee54fc9 | 69 | struct nfs_seqid_counter *sequence; |
4e51336a | 70 | struct list_head list; |
cee54fc9 TM |
71 | }; |
72 | ||
73 | static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status) | |
74 | { | |
75 | if (seqid_mutating_err(-status)) | |
76 | seqid->flags |= NFS_SEQID_CONFIRMED; | |
77 | } | |
78 | ||
9f958ab8 TM |
79 | struct nfs_unique_id { |
80 | struct rb_node rb_node; | |
81 | __u64 id; | |
82 | }; | |
83 | ||
4ce79717 TM |
84 | /* |
85 | * NFS4 state_owners and lock_owners are simply labels for ordered | |
86 | * sequences of RPC calls. Their sole purpose is to provide once-only | |
87 | * semantics by allowing the server to identify replayed requests. | |
4ce79717 TM |
88 | */ |
89 | struct nfs4_state_owner { | |
9f958ab8 | 90 | struct nfs_unique_id so_owner_id; |
adfa6f98 | 91 | struct nfs_client *so_client; |
6f2e64d3 | 92 | struct nfs_server *so_server; |
9f958ab8 | 93 | struct rb_node so_client_node; |
4ce79717 TM |
94 | |
95 | struct rpc_cred *so_cred; /* Associated cred */ | |
9f958ab8 TM |
96 | |
97 | spinlock_t so_lock; | |
98 | atomic_t so_count; | |
7eff03ae | 99 | unsigned long so_flags; |
4ce79717 TM |
100 | struct list_head so_states; |
101 | struct list_head so_delegations; | |
cee54fc9 TM |
102 | struct nfs_seqid_counter so_seqid; |
103 | struct rpc_sequence so_sequence; | |
4ce79717 TM |
104 | }; |
105 | ||
7eff03ae TM |
106 | enum { |
107 | NFS_OWNER_RECLAIM_REBOOT, | |
108 | NFS_OWNER_RECLAIM_NOGRACE | |
109 | }; | |
110 | ||
4ce79717 TM |
111 | /* |
112 | * struct nfs4_state maintains the client-side state for a given | |
113 | * (state_owner,inode) tuple (OPEN) or state_owner (LOCK). | |
114 | * | |
115 | * OPEN: | |
116 | * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server, | |
117 | * we need to know how many files are open for reading or writing on a | |
118 | * given inode. This information too is stored here. | |
119 | * | |
120 | * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN) | |
121 | */ | |
122 | ||
123 | struct nfs4_lock_state { | |
124 | struct list_head ls_locks; /* Other lock stateids */ | |
8d0a8a9d | 125 | struct nfs4_state * ls_state; /* Pointer to open state */ |
4ce79717 TM |
126 | fl_owner_t ls_owner; /* POSIX lock owner */ |
127 | #define NFS_LOCK_INITIALIZED 1 | |
128 | int ls_flags; | |
cee54fc9 | 129 | struct nfs_seqid_counter ls_seqid; |
d0dc3701 | 130 | struct rpc_sequence ls_sequence; |
9f958ab8 | 131 | struct nfs_unique_id ls_id; |
4ce79717 TM |
132 | nfs4_stateid ls_stateid; |
133 | atomic_t ls_count; | |
134 | }; | |
135 | ||
136 | /* bits for nfs4_state->flags */ | |
137 | enum { | |
138 | LK_STATE_IN_USE, | |
003707c7 TM |
139 | NFS_DELEGATED_STATE, /* Current stateid is delegation */ |
140 | NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */ | |
141 | NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */ | |
142 | NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */ | |
b79a4a1b TM |
143 | NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */ |
144 | NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */ | |
4ce79717 TM |
145 | }; |
146 | ||
147 | struct nfs4_state { | |
148 | struct list_head open_states; /* List of states for the same state_owner */ | |
149 | struct list_head inode_states; /* List of states for the same inode */ | |
150 | struct list_head lock_states; /* List of subservient lock stateids */ | |
151 | ||
152 | struct nfs4_state_owner *owner; /* Pointer to the open owner */ | |
153 | struct inode *inode; /* Pointer to the inode */ | |
154 | ||
155 | unsigned long flags; /* Do we hold any locks? */ | |
8d0a8a9d | 156 | spinlock_t state_lock; /* Protects the lock_states list */ |
4ce79717 | 157 | |
8bda4e4c | 158 | seqlock_t seqlock; /* Protects the stateid/open_stateid */ |
003707c7 TM |
159 | nfs4_stateid stateid; /* Current stateid: may be delegation */ |
160 | nfs4_stateid open_stateid; /* OPEN stateid */ | |
4ce79717 | 161 | |
8bda4e4c | 162 | /* The following 3 fields are protected by owner->so_lock */ |
003707c7 TM |
163 | unsigned int n_rdonly; /* Number of read-only references */ |
164 | unsigned int n_wronly; /* Number of write-only references */ | |
165 | unsigned int n_rdwr; /* Number of read/write references */ | |
dc0b027d | 166 | fmode_t state; /* State on the server (R,W, or RW) */ |
4ce79717 TM |
167 | atomic_t count; |
168 | }; | |
169 | ||
170 | ||
171 | struct nfs4_exception { | |
172 | long timeout; | |
173 | int retry; | |
9e33bed5 | 174 | struct nfs4_state *state; |
4ce79717 TM |
175 | }; |
176 | ||
177 | struct nfs4_state_recovery_ops { | |
7eff03ae | 178 | int owner_flag_bit; |
b79a4a1b | 179 | int state_flag_bit; |
4ce79717 TM |
180 | int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *); |
181 | int (*recover_lock)(struct nfs4_state *, struct file_lock *); | |
591d71cb | 182 | int (*establish_clid)(struct nfs_client *, struct rpc_cred *); |
90a16617 | 183 | struct rpc_cred * (*get_clid_cred)(struct nfs_client *); |
4ce79717 TM |
184 | }; |
185 | ||
29fba38b BH |
186 | struct nfs4_state_maintenance_ops { |
187 | int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *); | |
a7b72103 | 188 | struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *); |
8e69514f | 189 | int (*renew_lease)(struct nfs_client *, struct rpc_cred *); |
29fba38b BH |
190 | }; |
191 | ||
f786aa90 | 192 | extern const struct dentry_operations nfs4_dentry_operations; |
92e1d5be | 193 | extern const struct inode_operations nfs4_dir_inode_operations; |
6b3b5496 BF |
194 | |
195 | /* inode.c */ | |
196 | extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t); | |
197 | extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int); | |
198 | extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t); | |
199 | ||
4ce79717 TM |
200 | |
201 | /* nfs4proc.c */ | |
adfa6f98 DH |
202 | extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *); |
203 | extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *); | |
4d643d1d | 204 | extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred); |
adfa6f98 DH |
205 | extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *); |
206 | extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *); | |
591d71cb | 207 | extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *); |
4d643d1d | 208 | extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *); |
a49c3c77 | 209 | extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait); |
02a913a7 TM |
210 | extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *); |
211 | extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *); | |
55a97593 | 212 | extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle); |
56659e99 | 213 | extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name, |
7aaa0b3b | 214 | struct nfs4_fs_locations *fs_locations, struct page *page); |
4ce79717 | 215 | |
591d71cb AA |
216 | extern struct nfs4_state_recovery_ops *nfs4_reboot_recovery_ops[]; |
217 | extern struct nfs4_state_recovery_ops *nfs4_nograce_recovery_ops[]; | |
557134a3 | 218 | #if defined(CONFIG_NFS_V4_1) |
fbcd4abc AA |
219 | extern int nfs4_setup_sequence(struct nfs_client *clp, |
220 | struct nfs4_sequence_args *args, struct nfs4_sequence_res *res, | |
221 | int cache_reply, struct rpc_task *task); | |
557134a3 AA |
222 | extern void nfs4_destroy_session(struct nfs4_session *session); |
223 | extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp); | |
76db6d95 | 224 | extern int nfs4_proc_create_session(struct nfs_client *, int reset); |
c3fad1b1 | 225 | extern int nfs4_proc_destroy_session(struct nfs4_session *); |
fccba804 | 226 | extern int nfs4_init_session(struct nfs_server *server); |
fbcd4abc AA |
227 | #else /* CONFIG_NFS_v4_1 */ |
228 | static inline int nfs4_setup_sequence(struct nfs_client *clp, | |
229 | struct nfs4_sequence_args *args, struct nfs4_sequence_res *res, | |
230 | int cache_reply, struct rpc_task *task) | |
231 | { | |
232 | return 0; | |
233 | } | |
fccba804 TM |
234 | |
235 | static inline int nfs4_init_session(struct nfs_server *server) | |
236 | { | |
237 | return 0; | |
238 | } | |
557134a3 | 239 | #endif /* CONFIG_NFS_V4_1 */ |
4ce79717 | 240 | |
29fba38b BH |
241 | extern struct nfs4_state_maintenance_ops *nfs4_state_renewal_ops[]; |
242 | ||
4ce79717 TM |
243 | extern const u32 nfs4_fattr_bitmap[2]; |
244 | extern const u32 nfs4_statfs_bitmap[2]; | |
245 | extern const u32 nfs4_pathconf_bitmap[2]; | |
246 | extern const u32 nfs4_fsinfo_bitmap[2]; | |
830b8e33 | 247 | extern const u32 nfs4_fs_locations_bitmap[2]; |
4ce79717 TM |
248 | |
249 | /* nfs4renewd.c */ | |
adfa6f98 | 250 | extern void nfs4_schedule_state_renewal(struct nfs_client *); |
4ce79717 | 251 | extern void nfs4_renewd_prepare_shutdown(struct nfs_server *); |
adfa6f98 | 252 | extern void nfs4_kill_renewd(struct nfs_client *); |
65f27f38 | 253 | extern void nfs4_renew_state(struct work_struct *); |
4ce79717 TM |
254 | |
255 | /* nfs4state.c */ | |
a7b72103 | 256 | struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp); |
6dc9d57a | 257 | struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp); |
a7b72103 AA |
258 | #if defined(CONFIG_NFS_V4_1) |
259 | struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp); | |
b4b82607 | 260 | struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp); |
a7b72103 | 261 | #endif /* CONFIG_NFS_V4_1 */ |
4ce79717 TM |
262 | |
263 | extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *); | |
264 | extern void nfs4_put_state_owner(struct nfs4_state_owner *); | |
4ce79717 TM |
265 | extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *); |
266 | extern void nfs4_put_open_state(struct nfs4_state *); | |
dc0b027d TM |
267 | extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t); |
268 | extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t); | |
269 | extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t); | |
adfa6f98 | 270 | extern void nfs4_schedule_state_recovery(struct nfs_client *); |
b0d3ded1 | 271 | extern void nfs4_schedule_state_manager(struct nfs_client *); |
9e33bed5 | 272 | extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state); |
faf5f49c | 273 | extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp); |
8d0a8a9d | 274 | extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl); |
4ce79717 TM |
275 | extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t); |
276 | ||
cee54fc9 TM |
277 | extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter); |
278 | extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task); | |
279 | extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid); | |
280 | extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid); | |
281 | extern void nfs_free_seqid(struct nfs_seqid *seqid); | |
282 | ||
4ce79717 TM |
283 | extern const nfs4_stateid zero_stateid; |
284 | ||
285 | /* nfs4xdr.c */ | |
0dbb4c67 | 286 | extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus); |
4ce79717 TM |
287 | extern struct rpc_procinfo nfs4_procedures[]; |
288 | ||
289 | struct nfs4_mount_data; | |
290 | ||
291 | /* callback_xdr.c */ | |
292 | extern struct svc_version nfs4_callback_version1; | |
293 | ||
294 | #else | |
295 | ||
4a35bd41 | 296 | #define nfs4_close_state(a, b, c) do { } while (0) |
e9a40458 | 297 | #define nfs4_close_sync(a, b, c) do { } while (0) |
4ce79717 TM |
298 | |
299 | #endif /* CONFIG_NFS_V4 */ | |
300 | #endif /* __LINUX_FS_NFS_NFS4_FS.H */ |