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
64 struct nfs4_delegation {
65 struct list_head dl_perfile;
66 struct list_head dl_perclnt;
67 struct list_head dl_recall_lru; /* delegation recalled */
68 atomic_t dl_count; /* ref count */
69 struct nfs4_client *dl_client;
70 struct nfs4_file *dl_file;
71 struct file_lock *dl_flock;
72 struct file *dl_vfs_file;
78 struct knfsd_fh dl_fh;
82 /* client delegation callback info */
84 /* SETCLIENTID info */
86 unsigned short cb_port;
90 atomic_t cb_set; /* successful CB_NULL call */
91 struct rpc_clnt * cb_client;
92 struct rpc_cred * cb_cred;
95 /* Maximum number of slots per session. 128 is useful for long haul TCP */
96 #define NFSD_MAX_SLOTS_PER_SESSION 128
97 /* Maximum number of pages per slot cache entry */
98 #define NFSD_PAGES_PER_SLOT 1
99 /* Maximum number of operations per session compound */
100 #define NFSD_MAX_OPS_PER_COMPOUND 16
102 struct nfsd4_cache_entry {
104 struct kvec ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
105 struct page *ce_respages[NFSD_PAGES_PER_SLOT + 1];
115 struct nfsd4_cache_entry sl_cache_entry;
118 struct nfsd4_session {
120 struct list_head se_hash; /* hash by sessionid */
121 struct list_head se_perclnt;
123 struct nfs4_client *se_client; /* for expire_client */
124 struct nfs4_sessionid se_sessionid;
127 u32 se_fmaxresp_cached;
130 struct nfsd4_slot se_slots[]; /* forward channel slots */
134 nfsd4_put_session(struct nfsd4_session *ses)
136 extern void free_session(struct kref *kref);
137 kref_put(&ses->se_ref, free_session);
141 nfsd4_get_session(struct nfsd4_session *ses)
143 kref_get(&ses->se_ref);
146 /* formatted contents of nfs4_sessionid */
147 struct nfsd4_sessionid {
153 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
156 * struct nfs4_client - one per client. Clientids live here.
157 * o Each nfs4_client is hashed by clientid.
159 * o Each nfs4_clients is also hashed by name
160 * (the opaque quantity initially sent by the client to identify itself).
162 * o cl_perclient list is used to ensure no dangling stateowner references
163 * when we expire the nfs4_client
166 struct list_head cl_idhash; /* hash by cl_clientid.id */
167 struct list_head cl_strhash; /* hash by cl_name */
168 struct list_head cl_openowners;
169 struct list_head cl_delegations;
170 struct list_head cl_lru; /* tail queue */
171 struct xdr_netobj cl_name; /* id generated by client */
172 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
173 nfs4_verifier cl_verifier; /* generated by client */
174 time_t cl_time; /* time of last lease renewal */
175 __be32 cl_addr; /* client ipaddress */
176 u32 cl_flavor; /* setclientid pseudoflavor */
177 char *cl_principal; /* setclientid principal name */
178 struct svc_cred cl_cred; /* setclientid principal */
179 clientid_t cl_clientid; /* generated by server */
180 nfs4_verifier cl_confirm; /* generated by server */
181 struct nfs4_cb_conn cl_cb_conn; /* callback info */
182 atomic_t cl_count; /* ref count */
183 u32 cl_firststate; /* recovery dir creation */
186 struct list_head cl_sessions;
187 struct nfsd4_slot cl_slot; /* create_session slot */
188 u32 cl_exchange_flags;
189 struct nfs4_sessionid cl_sessionid;
192 /* struct nfs4_client_reset
193 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
194 * upon lease reset, or from upcall to state_daemon (to read in state
195 * from non-volitile storage) upon reboot.
197 struct nfs4_client_reclaim {
198 struct list_head cr_strhash; /* hash by cr_name */
199 char cr_recdir[HEXDIR_LEN]; /* recover dir */
203 update_stateid(stateid_t *stateid)
205 stateid->si_generation++;
208 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
209 * The OPEN response, typically the largest, requires
210 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
211 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
212 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
215 #define NFSD4_REPLAY_ISIZE 112
218 * Replay buffer, where the result of the last seqid-mutating operation
223 unsigned int rp_buflen;
225 unsigned intrp_allocated;
226 struct knfsd_fh rp_openfh;
227 char rp_ibuf[NFSD4_REPLAY_ISIZE];
231 * nfs4_stateowner can either be an open_owner, or a lock_owner
233 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
235 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
237 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
239 * so_perfilestate: heads the list of nfs4_stateid (either open or lock)
240 * and is used to ensure no dangling nfs4_stateid references when we
241 * release a stateowner.
242 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
243 * close is called to reap associated byte-range locks
244 * so_close_lru: (open) stateowner is placed on this list instead of being
245 * reaped (when so_perfilestate is empty) to hold the last close replay.
246 * reaped by laundramat thread after lease period.
248 struct nfs4_stateowner {
250 struct list_head so_idhash; /* hash by so_id */
251 struct list_head so_strhash; /* hash by op_name */
252 struct list_head so_perclient;
253 struct list_head so_stateids;
254 struct list_head so_perstateid; /* for lockowners only */
255 struct list_head so_close_lru; /* tail queue */
256 time_t so_time; /* time of placement on so_close_lru */
257 int so_is_open_owner; /* 1=openowner,0=lockowner */
259 struct nfs4_client * so_client;
260 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
261 * sequence id expected from the client: */
263 struct xdr_netobj so_owner; /* open owner name */
264 int so_confirmed; /* successful OPEN_CONFIRM? */
265 struct nfs4_replay so_replay;
269 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
270 * o fi_perfile list is used to search for conflicting
271 * share_acces, share_deny on the file.
275 struct list_head fi_hash; /* hash by "struct inode *" */
276 struct list_head fi_stateids;
277 struct list_head fi_delegations;
278 struct inode *fi_inode;
279 u32 fi_id; /* used with stateowner->so_id
280 * for stateid_hashtbl hash */
281 bool fi_had_conflict;
285 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
287 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
289 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
290 * st_perfile: file_hashtbl[] entry.
291 * st_perfile_state: nfs4_stateowner->so_perfilestate
292 * st_perlockowner: (open stateid) list of lock nfs4_stateowners
293 * st_access_bmap: used only for open stateid
294 * st_deny_bmap: used only for open stateid
295 * st_openstp: open stateid lock stateid was derived from
297 * XXX: open stateids and lock stateids have diverged sufficiently that
298 * we should consider defining separate structs for the two cases.
301 struct nfs4_stateid {
302 struct list_head st_hash;
303 struct list_head st_perfile;
304 struct list_head st_perstateowner;
305 struct list_head st_lockowners;
306 struct nfs4_stateowner * st_stateowner;
307 struct nfs4_file * st_file;
308 stateid_t st_stateid;
309 struct file * st_vfs_file;
310 unsigned long st_access_bmap;
311 unsigned long st_deny_bmap;
312 struct nfs4_stateid * st_openstp;
315 /* flags for preprocess_seqid_op() */
316 #define HAS_SESSION 0x00000001
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 struct nfsd4_compound_state;
332 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
333 stateid_t *stateid, int flags, struct file **filp);
334 extern void nfs4_lock_state(void);
335 extern void nfs4_unlock_state(void);
336 extern int nfs4_in_grace(void);
337 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
338 extern void put_nfs4_client(struct nfs4_client *clp);
339 extern void nfs4_free_stateowner(struct kref *kref);
340 extern void nfsd4_probe_callback(struct nfs4_client *clp);
341 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
342 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
343 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
344 extern void nfsd4_init_recdir(char *recdir_name);
345 extern int nfsd4_recdir_load(void);
346 extern void nfsd4_shutdown_recdir(void);
347 extern int nfs4_client_to_reclaim(const char *name);
348 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
349 extern void nfsd4_recdir_purge_old(void);
350 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
351 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
354 nfs4_put_stateowner(struct nfs4_stateowner *so)
356 kref_put(&so->so_ref, nfs4_free_stateowner);
360 nfs4_get_stateowner(struct nfs4_stateowner *so)
362 kref_get(&so->so_ref);
365 #endif /* NFSD4_STATE_H */