2 * linux/include/nfsd/state.h
4 * Copyright (c) 2001 The Regents of the University of Michigan.
7 * Kendrick Smith <kmsmith@umich.edu>
8 * Andy Adamson <andros@umich.edu>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #ifndef _NFSD4_STATE_H
38 #define _NFSD4_STATE_H
40 #include <linux/list.h>
41 #include <linux/kref.h>
42 #include <linux/sunrpc/clnt.h>
44 #define NFS4_OPAQUE_LIMIT 1024
58 stateid_opaque_t si_opaque;
60 #define si_boot si_opaque.so_boot
61 #define si_stateownerid si_opaque.so_stateownerid
62 #define si_fileid si_opaque.so_fileid
65 struct nfs4_cb_recall {
68 stateid_t cbr_stateid;
69 struct knfsd_fh cbr_fh;
70 struct nfs4_delegation *cbr_dp;
73 struct nfs4_delegation {
74 struct list_head dl_perfile;
75 struct list_head dl_perclnt;
76 struct list_head dl_recall_lru; /* delegation recalled */
77 atomic_t dl_count; /* ref count */
78 struct nfs4_client *dl_client;
79 struct nfs4_file *dl_file;
80 struct file_lock *dl_flock;
81 struct file *dl_vfs_file;
84 struct nfs4_cb_recall dl_recall;
87 #define dl_stateid dl_recall.cbr_stateid
88 #define dl_fh dl_recall.cbr_fh
90 /* client delegation callback info */
91 struct nfs4_callback {
92 /* SETCLIENTID info */
94 unsigned short cb_port;
98 atomic_t cb_set; /* successful CB_NULL call */
99 struct rpc_clnt * cb_client;
107 struct nfsd4_session {
109 struct list_head se_hash; /* hash by sessionid */
110 struct list_head se_perclnt;
112 struct nfs4_client *se_client; /* for expire_client */
113 struct nfs4_sessionid se_sessionid;
116 u32 se_fmaxresp_cached;
119 struct nfsd4_slot *se_slots; /* forward channel slots */
123 nfsd4_put_session(struct nfsd4_session *ses)
125 extern void free_session(struct kref *kref);
126 kref_put(&ses->se_ref, free_session);
130 nfsd4_get_session(struct nfsd4_session *ses)
132 kref_get(&ses->se_ref);
135 /* formatted contents of nfs4_sessionid */
136 struct nfsd4_sessionid {
142 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
145 * struct nfs4_client - one per client. Clientids live here.
146 * o Each nfs4_client is hashed by clientid.
148 * o Each nfs4_clients is also hashed by name
149 * (the opaque quantity initially sent by the client to identify itself).
151 * o cl_perclient list is used to ensure no dangling stateowner references
152 * when we expire the nfs4_client
155 struct list_head cl_idhash; /* hash by cl_clientid.id */
156 struct list_head cl_strhash; /* hash by cl_name */
157 struct list_head cl_openowners;
158 struct list_head cl_delegations;
159 struct list_head cl_lru; /* tail queue */
160 struct xdr_netobj cl_name; /* id generated by client */
161 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
162 nfs4_verifier cl_verifier; /* generated by client */
163 time_t cl_time; /* time of last lease renewal */
164 __be32 cl_addr; /* client ipaddress */
165 u32 cl_flavor; /* setclientid pseudoflavor */
166 char *cl_principal; /* setclientid principal name */
167 struct svc_cred cl_cred; /* setclientid principal */
168 clientid_t cl_clientid; /* generated by server */
169 nfs4_verifier cl_confirm; /* generated by server */
170 struct nfs4_callback cl_callback; /* callback info */
171 atomic_t cl_count; /* ref count */
172 u32 cl_firststate; /* recovery dir creation */
175 struct list_head cl_sessions;
176 u32 cl_seqid; /* seqid for create_session */
177 u32 cl_exchange_flags;
180 /* struct nfs4_client_reset
181 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
182 * upon lease reset, or from upcall to state_daemon (to read in state
183 * from non-volitile storage) upon reboot.
185 struct nfs4_client_reclaim {
186 struct list_head cr_strhash; /* hash by cr_name */
187 char cr_recdir[HEXDIR_LEN]; /* recover dir */
191 update_stateid(stateid_t *stateid)
193 stateid->si_generation++;
196 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
197 * The OPEN response, typically the largest, requires
198 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
199 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
200 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
203 #define NFSD4_REPLAY_ISIZE 112
206 * Replay buffer, where the result of the last seqid-mutating operation
211 unsigned int rp_buflen;
213 unsigned intrp_allocated;
214 struct knfsd_fh rp_openfh;
215 char rp_ibuf[NFSD4_REPLAY_ISIZE];
219 * nfs4_stateowner can either be an open_owner, or a lock_owner
221 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
223 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
225 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
227 * so_perfilestate: heads the list of nfs4_stateid (either open or lock)
228 * and is used to ensure no dangling nfs4_stateid references when we
229 * release a stateowner.
230 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
231 * close is called to reap associated byte-range locks
232 * so_close_lru: (open) stateowner is placed on this list instead of being
233 * reaped (when so_perfilestate is empty) to hold the last close replay.
234 * reaped by laundramat thread after lease period.
236 struct nfs4_stateowner {
238 struct list_head so_idhash; /* hash by so_id */
239 struct list_head so_strhash; /* hash by op_name */
240 struct list_head so_perclient;
241 struct list_head so_stateids;
242 struct list_head so_perstateid; /* for lockowners only */
243 struct list_head so_close_lru; /* tail queue */
244 time_t so_time; /* time of placement on so_close_lru */
245 int so_is_open_owner; /* 1=openowner,0=lockowner */
247 struct nfs4_client * so_client;
248 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
249 * sequence id expected from the client: */
251 struct xdr_netobj so_owner; /* open owner name */
252 int so_confirmed; /* successful OPEN_CONFIRM? */
253 struct nfs4_replay so_replay;
257 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
258 * o fi_perfile list is used to search for conflicting
259 * share_acces, share_deny on the file.
263 struct list_head fi_hash; /* hash by "struct inode *" */
264 struct list_head fi_stateids;
265 struct list_head fi_delegations;
266 struct inode *fi_inode;
267 u32 fi_id; /* used with stateowner->so_id
268 * for stateid_hashtbl hash */
269 bool fi_had_conflict;
273 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
275 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
277 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
278 * st_perfile: file_hashtbl[] entry.
279 * st_perfile_state: nfs4_stateowner->so_perfilestate
280 * st_perlockowner: (open stateid) list of lock nfs4_stateowners
281 * st_access_bmap: used only for open stateid
282 * st_deny_bmap: used only for open stateid
283 * st_openstp: open stateid lock stateid was derived from
285 * XXX: open stateids and lock stateids have diverged sufficiently that
286 * we should consider defining separate structs for the two cases.
289 struct nfs4_stateid {
290 struct list_head st_hash;
291 struct list_head st_perfile;
292 struct list_head st_perstateowner;
293 struct list_head st_lockowners;
294 struct nfs4_stateowner * st_stateowner;
295 struct nfs4_file * st_file;
296 stateid_t st_stateid;
297 struct file * st_vfs_file;
298 unsigned long st_access_bmap;
299 unsigned long st_deny_bmap;
300 struct nfs4_stateid * st_openstp;
303 /* flags for preprocess_seqid_op() */
304 #define CONFIRM 0x00000002
305 #define OPEN_STATE 0x00000004
306 #define LOCK_STATE 0x00000008
307 #define RD_STATE 0x00000010
308 #define WR_STATE 0x00000020
309 #define CLOSE_STATE 0x00000040
311 #define seqid_mutating_err(err) \
312 (((err) != nfserr_stale_clientid) && \
313 ((err) != nfserr_bad_seqid) && \
314 ((err) != nfserr_stale_stateid) && \
315 ((err) != nfserr_bad_stateid))
317 extern __be32 nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
318 stateid_t *stateid, int flags, struct file **filp);
319 extern void nfs4_lock_state(void);
320 extern void nfs4_unlock_state(void);
321 extern int nfs4_in_grace(void);
322 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
323 extern void put_nfs4_client(struct nfs4_client *clp);
324 extern void nfs4_free_stateowner(struct kref *kref);
325 extern void nfsd4_probe_callback(struct nfs4_client *clp);
326 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
327 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
328 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
329 extern void nfsd4_init_recdir(char *recdir_name);
330 extern int nfsd4_recdir_load(void);
331 extern void nfsd4_shutdown_recdir(void);
332 extern int nfs4_client_to_reclaim(const char *name);
333 extern int nfs4_has_reclaimed_state(const char *name);
334 extern void nfsd4_recdir_purge_old(void);
335 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
336 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
339 nfs4_put_stateowner(struct nfs4_stateowner *so)
341 kref_put(&so->so_ref, nfs4_free_stateowner);
345 nfs4_get_stateowner(struct nfs4_stateowner *so)
347 kref_get(&so->so_ref);
350 #endif /* NFSD4_STATE_H */