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;
70 u32 cbr_fhval[NFS4_FHSIZE];
71 struct nfs4_delegation *cbr_dp;
74 struct nfs4_delegation {
75 struct list_head dl_perfile;
76 struct list_head dl_perclnt;
77 struct list_head dl_recall_lru; /* delegation recalled */
78 atomic_t dl_count; /* ref count */
79 struct nfs4_client *dl_client;
80 struct nfs4_file *dl_file;
81 struct file_lock *dl_flock;
82 struct file *dl_vfs_file;
85 struct nfs4_cb_recall dl_recall;
88 #define dl_stateid dl_recall.cbr_stateid
89 #define dl_fhlen dl_recall.cbr_fhlen
90 #define dl_fhval dl_recall.cbr_fhval
92 /* client delegation callback info */
93 struct nfs4_callback {
94 /* SETCLIENTID info */
96 unsigned short cb_port;
100 atomic_t cb_set; /* successful CB_NULL call */
101 struct rpc_program cb_program;
102 struct rpc_stat cb_stat;
103 struct rpc_clnt * cb_client;
106 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
109 * struct nfs4_client - one per client. Clientids live here.
110 * o Each nfs4_client is hashed by clientid.
112 * o Each nfs4_clients is also hashed by name
113 * (the opaque quantity initially sent by the client to identify itself).
115 * o cl_perclient list is used to ensure no dangling stateowner references
116 * when we expire the nfs4_client
119 struct list_head cl_idhash; /* hash by cl_clientid.id */
120 struct list_head cl_strhash; /* hash by cl_name */
121 struct list_head cl_openowners;
122 struct list_head cl_delegations;
123 struct list_head cl_lru; /* tail queue */
124 struct xdr_netobj cl_name; /* id generated by client */
125 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
126 nfs4_verifier cl_verifier; /* generated by client */
127 time_t cl_time; /* time of last lease renewal */
128 u32 cl_addr; /* client ipaddress */
129 struct svc_cred cl_cred; /* setclientid principal */
130 clientid_t cl_clientid; /* generated by server */
131 nfs4_verifier cl_confirm; /* generated by server */
132 struct nfs4_callback cl_callback; /* callback info */
133 atomic_t cl_count; /* ref count */
136 /* struct nfs4_client_reset
137 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
138 * upon lease reset, or from upcall to state_daemon (to read in state
139 * from non-volitile storage) upon reboot.
141 struct nfs4_client_reclaim {
142 struct list_head cr_strhash; /* hash by cr_name */
143 char cr_recdir[HEXDIR_LEN]; /* recover dir */
147 update_stateid(stateid_t *stateid)
149 stateid->si_generation++;
152 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
153 * The OPEN response, typically the largest, requires
154 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
155 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
156 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
159 #define NFSD4_REPLAY_ISIZE 112
162 * Replay buffer, where the result of the last seqid-mutating operation
167 unsigned int rp_buflen;
169 unsigned intrp_allocated;
171 char rp_openfh[NFS4_FHSIZE];
172 char rp_ibuf[NFSD4_REPLAY_ISIZE];
176 * nfs4_stateowner can either be an open_owner, or a lock_owner
178 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
180 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
182 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
184 * so_perfilestate: heads the list of nfs4_stateid (either open or lock)
185 * and is used to ensure no dangling nfs4_stateid references when we
186 * release a stateowner.
187 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
188 * close is called to reap associated byte-range locks
189 * so_close_lru: (open) stateowner is placed on this list instead of being
190 * reaped (when so_perfilestate is empty) to hold the last close replay.
191 * reaped by laundramat thread after lease period.
193 struct nfs4_stateowner {
195 struct list_head so_idhash; /* hash by so_id */
196 struct list_head so_strhash; /* hash by op_name */
197 struct list_head so_perclient;
198 struct list_head so_stateids;
199 struct list_head so_perstateid; /* for lockowners only */
200 struct list_head so_close_lru; /* tail queue */
201 time_t so_time; /* time of placement on so_close_lru */
202 int so_is_open_owner; /* 1=openowner,0=lockowner */
204 struct nfs4_client * so_client;
206 struct xdr_netobj so_owner; /* open owner name */
207 int so_confirmed; /* successful OPEN_CONFIRM? */
208 struct nfs4_replay so_replay;
212 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
213 * o fi_perfile list is used to search for conflicting
214 * share_acces, share_deny on the file.
218 struct list_head fi_hash; /* hash by "struct inode *" */
219 struct list_head fi_stateids;
220 struct list_head fi_delegations;
221 struct inode *fi_inode;
222 u32 fi_id; /* used with stateowner->so_id
223 * for stateid_hashtbl hash */
227 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
229 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
231 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
232 * st_perfile: file_hashtbl[] entry.
233 * st_perfile_state: nfs4_stateowner->so_perfilestate
234 * st_perlockowner: (open stateid) list of lock nfs4_stateowners
235 * st_access_bmap: used only for open stateid
236 * st_deny_bmap: used only for open stateid
239 struct nfs4_stateid {
240 struct list_head st_hash;
241 struct list_head st_perfile;
242 struct list_head st_perstateowner;
243 struct list_head st_lockowners;
244 struct nfs4_stateowner * st_stateowner;
245 struct nfs4_file * st_file;
246 stateid_t st_stateid;
247 struct file * st_vfs_file;
248 unsigned long st_access_bmap;
249 unsigned long st_deny_bmap;
252 /* flags for preprocess_seqid_op() */
253 #define CHECK_FH 0x00000001
254 #define CONFIRM 0x00000002
255 #define OPEN_STATE 0x00000004
256 #define LOCK_STATE 0x00000008
257 #define RD_STATE 0x00000010
258 #define WR_STATE 0x00000020
259 #define CLOSE_STATE 0x00000040
260 #define DELEG_RET 0x00000080
262 #define seqid_mutating_err(err) \
263 (((err) != nfserr_stale_clientid) && \
264 ((err) != nfserr_bad_seqid) && \
265 ((err) != nfserr_stale_stateid) && \
266 ((err) != nfserr_bad_stateid))
268 extern int nfsd4_renew(clientid_t *clid);
269 extern int nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
270 stateid_t *stateid, int flags, struct file **filp);
271 extern void nfs4_lock_state(void);
272 extern void nfs4_unlock_state(void);
273 extern int nfs4_in_grace(void);
274 extern int nfs4_check_open_reclaim(clientid_t *clid);
275 extern void put_nfs4_client(struct nfs4_client *clp);
276 extern void nfs4_free_stateowner(struct kref *kref);
277 extern void nfsd4_probe_callback(struct nfs4_client *clp);
278 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
279 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
280 extern int nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
283 nfs4_put_stateowner(struct nfs4_stateowner *so)
285 kref_put(&so->so_ref, nfs4_free_stateowner);
289 nfs4_get_stateowner(struct nfs4_stateowner *so)
291 kref_get(&so->so_ref);
294 #endif /* NFSD4_STATE_H */