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;
102 /* Maximum number of pages per slot cache entry */
103 #define NFSD_PAGES_PER_SLOT 1
105 struct nfsd4_cache_entry {
107 struct kvec ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
108 struct page *ce_respages[NFSD_PAGES_PER_SLOT + 1];
117 struct nfsd4_cache_entry sl_cache_entry;
120 struct nfsd4_session {
122 struct list_head se_hash; /* hash by sessionid */
123 struct list_head se_perclnt;
125 struct nfs4_client *se_client; /* for expire_client */
126 struct nfs4_sessionid se_sessionid;
129 u32 se_fmaxresp_cached;
132 struct nfsd4_slot *se_slots; /* forward channel slots */
136 nfsd4_put_session(struct nfsd4_session *ses)
138 extern void free_session(struct kref *kref);
139 kref_put(&ses->se_ref, free_session);
143 nfsd4_get_session(struct nfsd4_session *ses)
145 kref_get(&ses->se_ref);
148 /* formatted contents of nfs4_sessionid */
149 struct nfsd4_sessionid {
155 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
158 * struct nfs4_client - one per client. Clientids live here.
159 * o Each nfs4_client is hashed by clientid.
161 * o Each nfs4_clients is also hashed by name
162 * (the opaque quantity initially sent by the client to identify itself).
164 * o cl_perclient list is used to ensure no dangling stateowner references
165 * when we expire the nfs4_client
168 struct list_head cl_idhash; /* hash by cl_clientid.id */
169 struct list_head cl_strhash; /* hash by cl_name */
170 struct list_head cl_openowners;
171 struct list_head cl_delegations;
172 struct list_head cl_lru; /* tail queue */
173 struct xdr_netobj cl_name; /* id generated by client */
174 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
175 nfs4_verifier cl_verifier; /* generated by client */
176 time_t cl_time; /* time of last lease renewal */
177 __be32 cl_addr; /* client ipaddress */
178 u32 cl_flavor; /* setclientid pseudoflavor */
179 char *cl_principal; /* setclientid principal name */
180 struct svc_cred cl_cred; /* setclientid principal */
181 clientid_t cl_clientid; /* generated by server */
182 nfs4_verifier cl_confirm; /* generated by server */
183 struct nfs4_callback cl_callback; /* callback info */
184 atomic_t cl_count; /* ref count */
185 u32 cl_firststate; /* recovery dir creation */
188 struct list_head cl_sessions;
189 u32 cl_seqid; /* seqid for create_session */
190 u32 cl_exchange_flags;
193 /* struct nfs4_client_reset
194 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
195 * upon lease reset, or from upcall to state_daemon (to read in state
196 * from non-volitile storage) upon reboot.
198 struct nfs4_client_reclaim {
199 struct list_head cr_strhash; /* hash by cr_name */
200 char cr_recdir[HEXDIR_LEN]; /* recover dir */
204 update_stateid(stateid_t *stateid)
206 stateid->si_generation++;
209 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
210 * The OPEN response, typically the largest, requires
211 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
212 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
213 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
216 #define NFSD4_REPLAY_ISIZE 112
219 * Replay buffer, where the result of the last seqid-mutating operation
224 unsigned int rp_buflen;
226 unsigned intrp_allocated;
227 struct knfsd_fh rp_openfh;
228 char rp_ibuf[NFSD4_REPLAY_ISIZE];
232 * nfs4_stateowner can either be an open_owner, or a lock_owner
234 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
236 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
238 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
240 * so_perfilestate: heads the list of nfs4_stateid (either open or lock)
241 * and is used to ensure no dangling nfs4_stateid references when we
242 * release a stateowner.
243 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
244 * close is called to reap associated byte-range locks
245 * so_close_lru: (open) stateowner is placed on this list instead of being
246 * reaped (when so_perfilestate is empty) to hold the last close replay.
247 * reaped by laundramat thread after lease period.
249 struct nfs4_stateowner {
251 struct list_head so_idhash; /* hash by so_id */
252 struct list_head so_strhash; /* hash by op_name */
253 struct list_head so_perclient;
254 struct list_head so_stateids;
255 struct list_head so_perstateid; /* for lockowners only */
256 struct list_head so_close_lru; /* tail queue */
257 time_t so_time; /* time of placement on so_close_lru */
258 int so_is_open_owner; /* 1=openowner,0=lockowner */
260 struct nfs4_client * so_client;
261 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
262 * sequence id expected from the client: */
264 struct xdr_netobj so_owner; /* open owner name */
265 int so_confirmed; /* successful OPEN_CONFIRM? */
266 struct nfs4_replay so_replay;
270 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
271 * o fi_perfile list is used to search for conflicting
272 * share_acces, share_deny on the file.
276 struct list_head fi_hash; /* hash by "struct inode *" */
277 struct list_head fi_stateids;
278 struct list_head fi_delegations;
279 struct inode *fi_inode;
280 u32 fi_id; /* used with stateowner->so_id
281 * for stateid_hashtbl hash */
282 bool fi_had_conflict;
286 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
288 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
290 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
291 * st_perfile: file_hashtbl[] entry.
292 * st_perfile_state: nfs4_stateowner->so_perfilestate
293 * st_perlockowner: (open stateid) list of lock nfs4_stateowners
294 * st_access_bmap: used only for open stateid
295 * st_deny_bmap: used only for open stateid
296 * st_openstp: open stateid lock stateid was derived from
298 * XXX: open stateids and lock stateids have diverged sufficiently that
299 * we should consider defining separate structs for the two cases.
302 struct nfs4_stateid {
303 struct list_head st_hash;
304 struct list_head st_perfile;
305 struct list_head st_perstateowner;
306 struct list_head st_lockowners;
307 struct nfs4_stateowner * st_stateowner;
308 struct nfs4_file * st_file;
309 stateid_t st_stateid;
310 struct file * st_vfs_file;
311 unsigned long st_access_bmap;
312 unsigned long st_deny_bmap;
313 struct nfs4_stateid * st_openstp;
316 /* flags for preprocess_seqid_op() */
317 #define CONFIRM 0x00000002
318 #define OPEN_STATE 0x00000004
319 #define LOCK_STATE 0x00000008
320 #define RD_STATE 0x00000010
321 #define WR_STATE 0x00000020
322 #define CLOSE_STATE 0x00000040
324 #define seqid_mutating_err(err) \
325 (((err) != nfserr_stale_clientid) && \
326 ((err) != nfserr_bad_seqid) && \
327 ((err) != nfserr_stale_stateid) && \
328 ((err) != nfserr_bad_stateid))
330 extern __be32 nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
331 stateid_t *stateid, int flags, struct file **filp);
332 extern void nfs4_lock_state(void);
333 extern void nfs4_unlock_state(void);
334 extern int nfs4_in_grace(void);
335 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
336 extern void put_nfs4_client(struct nfs4_client *clp);
337 extern void nfs4_free_stateowner(struct kref *kref);
338 extern void nfsd4_probe_callback(struct nfs4_client *clp);
339 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
340 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
341 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
342 extern void nfsd4_init_recdir(char *recdir_name);
343 extern int nfsd4_recdir_load(void);
344 extern void nfsd4_shutdown_recdir(void);
345 extern int nfs4_client_to_reclaim(const char *name);
346 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
347 extern void nfsd4_recdir_purge_old(void);
348 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
349 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
352 nfs4_put_stateowner(struct nfs4_stateowner *so)
354 kref_put(&so->so_ref, nfs4_free_stateowner);
358 nfs4_get_stateowner(struct nfs4_stateowner *so)
360 kref_get(&so->so_ref);
363 #endif /* NFSD4_STATE_H */