aboutsummaryrefslogtreecommitdiffstats
path: root/fs/nfsd/state.h
diff options
context:
space:
mode:
authorBoaz Harrosh <bharrosh@panasas.com>2009-12-03 13:30:56 -0500
committerJ. Bruce Fields <bfields@citi.umich.edu>2009-12-14 18:12:12 -0500
commit9a74af21330c8d46efa977d088a62cc1bfa954e9 (patch)
tree6f2e4b775738ae93da05ad475b244785bf40461e /fs/nfsd/state.h
parent68590c382b875cc9a76b06097f3dff6730d787c1 (diff)
nfsd: Move private headers to source directory
Lots of include/linux/nfsd/* headers are only used by nfsd module. Move them to the source directory Signed-off-by: Boaz Harrosh <bharrosh@panasas.com> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
Diffstat (limited to 'fs/nfsd/state.h')
-rw-r--r--fs/nfsd/state.h409
1 files changed, 409 insertions, 0 deletions
diff --git a/fs/nfsd/state.h b/fs/nfsd/state.h
new file mode 100644
index 000000000000..2af75686e0d3
--- /dev/null
+++ b/fs/nfsd/state.h
@@ -0,0 +1,409 @@
1/*
2 * linux/include/nfsd/state.h
3 *
4 * Copyright (c) 2001 The Regents of the University of Michigan.
5 * All rights reserved.
6 *
7 * Kendrick Smith <kmsmith@umich.edu>
8 * Andy Adamson <andros@umich.edu>
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 *
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.
22 *
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.
34 *
35 */
36
37#ifndef _NFSD4_STATE_H
38#define _NFSD4_STATE_H
39
40#include <linux/nfsd/nfsfh.h>
41
42typedef struct {
43 u32 cl_boot;
44 u32 cl_id;
45} clientid_t;
46
47typedef struct {
48 u32 so_boot;
49 u32 so_stateownerid;
50 u32 so_fileid;
51} stateid_opaque_t;
52
53typedef struct {
54 u32 si_generation;
55 stateid_opaque_t si_opaque;
56} stateid_t;
57#define si_boot si_opaque.so_boot
58#define si_stateownerid si_opaque.so_stateownerid
59#define si_fileid si_opaque.so_fileid
60
61#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
62#define STATEID_VAL(s) \
63 (s)->si_boot, \
64 (s)->si_stateownerid, \
65 (s)->si_fileid, \
66 (s)->si_generation
67
68struct nfsd4_cb_sequence {
69 /* args/res */
70 u32 cbs_minorversion;
71 struct nfs4_client *cbs_clp;
72};
73
74struct 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;
83 u32 dl_type;
84 time_t dl_time;
85/* For recall: */
86 u32 dl_ident;
87 stateid_t dl_stateid;
88 struct knfsd_fh dl_fh;
89 int dl_retries;
90};
91
92/* client delegation callback info */
93struct nfs4_cb_conn {
94 /* SETCLIENTID info */
95 struct sockaddr_storage cb_addr;
96 size_t cb_addrlen;
97 u32 cb_prog;
98 u32 cb_minorversion;
99 u32 cb_ident; /* minorversion 0 only */
100 /* RPC client info */
101 atomic_t cb_set; /* successful CB_NULL call */
102 struct rpc_clnt * cb_client;
103};
104
105/* Maximum number of slots per session. 160 is useful for long haul TCP */
106#define NFSD_MAX_SLOTS_PER_SESSION 160
107/* Maximum number of operations per session compound */
108#define NFSD_MAX_OPS_PER_COMPOUND 16
109/* Maximum session per slot cache size */
110#define NFSD_SLOT_CACHE_SIZE 1024
111/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
112#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
113#define NFSD_MAX_MEM_PER_SESSION \
114 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
115
116struct nfsd4_slot {
117 bool sl_inuse;
118 bool sl_cachethis;
119 u16 sl_opcnt;
120 u32 sl_seqid;
121 __be32 sl_status;
122 u32 sl_datalen;
123 char sl_data[];
124};
125
126struct nfsd4_channel_attrs {
127 u32 headerpadsz;
128 u32 maxreq_sz;
129 u32 maxresp_sz;
130 u32 maxresp_cached;
131 u32 maxops;
132 u32 maxreqs;
133 u32 nr_rdma_attrs;
134 u32 rdma_attrs;
135};
136
137struct nfsd4_create_session {
138 clientid_t clientid;
139 struct nfs4_sessionid sessionid;
140 u32 seqid;
141 u32 flags;
142 struct nfsd4_channel_attrs fore_channel;
143 struct nfsd4_channel_attrs back_channel;
144 u32 callback_prog;
145 u32 uid;
146 u32 gid;
147};
148
149/* The single slot clientid cache structure */
150struct nfsd4_clid_slot {
151 u32 sl_seqid;
152 __be32 sl_status;
153 struct nfsd4_create_session sl_cr_ses;
154};
155
156struct nfsd4_session {
157 struct kref se_ref;
158 struct list_head se_hash; /* hash by sessionid */
159 struct list_head se_perclnt;
160 u32 se_flags;
161 struct nfs4_client *se_client; /* for expire_client */
162 struct nfs4_sessionid se_sessionid;
163 struct nfsd4_channel_attrs se_fchannel;
164 struct nfsd4_channel_attrs se_bchannel;
165 struct nfsd4_slot *se_slots[]; /* forward channel slots */
166};
167
168static inline void
169nfsd4_put_session(struct nfsd4_session *ses)
170{
171 extern void free_session(struct kref *kref);
172 kref_put(&ses->se_ref, free_session);
173}
174
175static inline void
176nfsd4_get_session(struct nfsd4_session *ses)
177{
178 kref_get(&ses->se_ref);
179}
180
181/* formatted contents of nfs4_sessionid */
182struct nfsd4_sessionid {
183 clientid_t clientid;
184 u32 sequence;
185 u32 reserved;
186};
187
188#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
189
190/*
191 * struct nfs4_client - one per client. Clientids live here.
192 * o Each nfs4_client is hashed by clientid.
193 *
194 * o Each nfs4_clients is also hashed by name
195 * (the opaque quantity initially sent by the client to identify itself).
196 *
197 * o cl_perclient list is used to ensure no dangling stateowner references
198 * when we expire the nfs4_client
199 */
200struct nfs4_client {
201 struct list_head cl_idhash; /* hash by cl_clientid.id */
202 struct list_head cl_strhash; /* hash by cl_name */
203 struct list_head cl_openowners;
204 struct list_head cl_delegations;
205 struct list_head cl_lru; /* tail queue */
206 struct xdr_netobj cl_name; /* id generated by client */
207 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
208 nfs4_verifier cl_verifier; /* generated by client */
209 time_t cl_time; /* time of last lease renewal */
210 struct sockaddr_storage cl_addr; /* client ipaddress */
211 u32 cl_flavor; /* setclientid pseudoflavor */
212 char *cl_principal; /* setclientid principal name */
213 struct svc_cred cl_cred; /* setclientid principal */
214 clientid_t cl_clientid; /* generated by server */
215 nfs4_verifier cl_confirm; /* generated by server */
216 struct nfs4_cb_conn cl_cb_conn; /* callback info */
217 atomic_t cl_count; /* ref count */
218 u32 cl_firststate; /* recovery dir creation */
219
220 /* for nfs41 */
221 struct list_head cl_sessions;
222 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
223 u32 cl_exchange_flags;
224 struct nfs4_sessionid cl_sessionid;
225
226 /* for nfs41 callbacks */
227 /* We currently support a single back channel with a single slot */
228 unsigned long cl_cb_slot_busy;
229 u32 cl_cb_seq_nr;
230 struct svc_xprt *cl_cb_xprt; /* 4.1 callback transport */
231 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
232 /* wait here for slots */
233};
234
235/* struct nfs4_client_reset
236 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
237 * upon lease reset, or from upcall to state_daemon (to read in state
238 * from non-volitile storage) upon reboot.
239 */
240struct nfs4_client_reclaim {
241 struct list_head cr_strhash; /* hash by cr_name */
242 char cr_recdir[HEXDIR_LEN]; /* recover dir */
243};
244
245static inline void
246update_stateid(stateid_t *stateid)
247{
248 stateid->si_generation++;
249}
250
251/* A reasonable value for REPLAY_ISIZE was estimated as follows:
252 * The OPEN response, typically the largest, requires
253 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
254 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
255 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
256 */
257
258#define NFSD4_REPLAY_ISIZE 112
259
260/*
261 * Replay buffer, where the result of the last seqid-mutating operation
262 * is cached.
263 */
264struct nfs4_replay {
265 __be32 rp_status;
266 unsigned int rp_buflen;
267 char *rp_buf;
268 unsigned intrp_allocated;
269 struct knfsd_fh rp_openfh;
270 char rp_ibuf[NFSD4_REPLAY_ISIZE];
271};
272
273/*
274* nfs4_stateowner can either be an open_owner, or a lock_owner
275*
276* so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
277* for lock_owner
278* so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
279* for lock_owner
280* so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
281* struct is reaped.
282* so_perfilestate: heads the list of nfs4_stateid (either open or lock)
283* and is used to ensure no dangling nfs4_stateid references when we
284* release a stateowner.
285* so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
286* close is called to reap associated byte-range locks
287* so_close_lru: (open) stateowner is placed on this list instead of being
288* reaped (when so_perfilestate is empty) to hold the last close replay.
289* reaped by laundramat thread after lease period.
290*/
291struct nfs4_stateowner {
292 struct kref so_ref;
293 struct list_head so_idhash; /* hash by so_id */
294 struct list_head so_strhash; /* hash by op_name */
295 struct list_head so_perclient;
296 struct list_head so_stateids;
297 struct list_head so_perstateid; /* for lockowners only */
298 struct list_head so_close_lru; /* tail queue */
299 time_t so_time; /* time of placement on so_close_lru */
300 int so_is_open_owner; /* 1=openowner,0=lockowner */
301 u32 so_id;
302 struct nfs4_client * so_client;
303 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
304 * sequence id expected from the client: */
305 u32 so_seqid;
306 struct xdr_netobj so_owner; /* open owner name */
307 int so_confirmed; /* successful OPEN_CONFIRM? */
308 struct nfs4_replay so_replay;
309};
310
311/*
312* nfs4_file: a file opened by some number of (open) nfs4_stateowners.
313* o fi_perfile list is used to search for conflicting
314* share_acces, share_deny on the file.
315*/
316struct nfs4_file {
317 atomic_t fi_ref;
318 struct list_head fi_hash; /* hash by "struct inode *" */
319 struct list_head fi_stateids;
320 struct list_head fi_delegations;
321 struct inode *fi_inode;
322 u32 fi_id; /* used with stateowner->so_id
323 * for stateid_hashtbl hash */
324 bool fi_had_conflict;
325};
326
327/*
328* nfs4_stateid can either be an open stateid or (eventually) a lock stateid
329*
330* (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
331*
332* st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
333* st_perfile: file_hashtbl[] entry.
334* st_perfile_state: nfs4_stateowner->so_perfilestate
335* st_perlockowner: (open stateid) list of lock nfs4_stateowners
336* st_access_bmap: used only for open stateid
337* st_deny_bmap: used only for open stateid
338* st_openstp: open stateid lock stateid was derived from
339*
340* XXX: open stateids and lock stateids have diverged sufficiently that
341* we should consider defining separate structs for the two cases.
342*/
343
344struct nfs4_stateid {
345 struct list_head st_hash;
346 struct list_head st_perfile;
347 struct list_head st_perstateowner;
348 struct list_head st_lockowners;
349 struct nfs4_stateowner * st_stateowner;
350 struct nfs4_file * st_file;
351 stateid_t st_stateid;
352 struct file * st_vfs_file;
353 unsigned long st_access_bmap;
354 unsigned long st_deny_bmap;
355 struct nfs4_stateid * st_openstp;
356};
357
358/* flags for preprocess_seqid_op() */
359#define HAS_SESSION 0x00000001
360#define CONFIRM 0x00000002
361#define OPEN_STATE 0x00000004
362#define LOCK_STATE 0x00000008
363#define RD_STATE 0x00000010
364#define WR_STATE 0x00000020
365#define CLOSE_STATE 0x00000040
366
367#define seqid_mutating_err(err) \
368 (((err) != nfserr_stale_clientid) && \
369 ((err) != nfserr_bad_seqid) && \
370 ((err) != nfserr_stale_stateid) && \
371 ((err) != nfserr_bad_stateid))
372
373struct nfsd4_compound_state;
374
375extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
376 stateid_t *stateid, int flags, struct file **filp);
377extern void nfs4_lock_state(void);
378extern void nfs4_unlock_state(void);
379extern int nfs4_in_grace(void);
380extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
381extern void put_nfs4_client(struct nfs4_client *clp);
382extern void nfs4_free_stateowner(struct kref *kref);
383extern int set_callback_cred(void);
384extern void nfsd4_probe_callback(struct nfs4_client *clp);
385extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
386extern void nfs4_put_delegation(struct nfs4_delegation *dp);
387extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
388extern void nfsd4_init_recdir(char *recdir_name);
389extern int nfsd4_recdir_load(void);
390extern void nfsd4_shutdown_recdir(void);
391extern int nfs4_client_to_reclaim(const char *name);
392extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
393extern void nfsd4_recdir_purge_old(void);
394extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
395extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
396
397static inline void
398nfs4_put_stateowner(struct nfs4_stateowner *so)
399{
400 kref_put(&so->so_ref, nfs4_free_stateowner);
401}
402
403static inline void
404nfs4_get_stateowner(struct nfs4_stateowner *so)
405{
406 kref_get(&so->so_ref);
407}
408
409#endif /* NFSD4_STATE_H */
generated by cgit v1.2.2 (git 2.25.0) at 2024-12-02 06:53:17 -0500