Merge branch 'for-2.6.31' of git://git.linux-nfs.org/projects/trondmy/nfs-2.6
[linux-2.6.git] / include / linux / nfsd / state.h
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/list.h>
41 #include <linux/kref.h>
42 #include <linux/sunrpc/clnt.h>
43
44 typedef struct {
45         u32             cl_boot;
46         u32             cl_id;
47 } clientid_t;
48
49 typedef struct {
50         u32             so_boot;
51         u32             so_stateownerid;
52         u32             so_fileid;
53 } stateid_opaque_t;
54
55 typedef struct {
56         u32                     si_generation;
57         stateid_opaque_t        si_opaque;
58 } stateid_t;
59 #define si_boot           si_opaque.so_boot
60 #define si_stateownerid   si_opaque.so_stateownerid
61 #define si_fileid         si_opaque.so_fileid
62
63
64 struct nfs4_cb_recall {
65         u32                     cbr_ident;
66         int                     cbr_trunc;
67         stateid_t               cbr_stateid;
68         struct knfsd_fh         cbr_fh;
69         struct nfs4_delegation  *cbr_dp;
70 };
71
72 struct nfs4_delegation {
73         struct list_head        dl_perfile;
74         struct list_head        dl_perclnt;
75         struct list_head        dl_recall_lru;  /* delegation recalled */
76         atomic_t                dl_count;       /* ref count */
77         struct nfs4_client      *dl_client;
78         struct nfs4_file        *dl_file;
79         struct file_lock        *dl_flock;
80         struct file             *dl_vfs_file;
81         u32                     dl_type;
82         time_t                  dl_time;
83         struct nfs4_cb_recall   dl_recall;
84 };
85
86 #define dl_stateid      dl_recall.cbr_stateid
87 #define dl_fh           dl_recall.cbr_fh
88
89 /* client delegation callback info */
90 struct nfs4_callback {
91         /* SETCLIENTID info */
92         u32                     cb_addr;
93         unsigned short          cb_port;
94         u32                     cb_prog;
95         u32                     cb_ident;
96         /* RPC client info */
97         atomic_t                cb_set;     /* successful CB_NULL call */
98         struct rpc_clnt *       cb_client;
99 };
100
101 /* Maximum number of slots per session. 128 is useful for long haul TCP */
102 #define NFSD_MAX_SLOTS_PER_SESSION      128
103 /* Maximum number of pages per slot cache entry */
104 #define NFSD_PAGES_PER_SLOT     1
105 /* Maximum number of operations per session compound */
106 #define NFSD_MAX_OPS_PER_COMPOUND       16
107
108 struct nfsd4_cache_entry {
109         __be32          ce_status;
110         struct kvec     ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
111         struct page     *ce_respages[NFSD_PAGES_PER_SLOT + 1];
112         int             ce_cachethis;
113         short           ce_resused;
114         int             ce_opcnt;
115         int             ce_rpchdrlen;
116 };
117
118 struct nfsd4_slot {
119         bool                            sl_inuse;
120         u32                             sl_seqid;
121         struct nfsd4_cache_entry        sl_cache_entry;
122 };
123
124 struct nfsd4_session {
125         struct kref             se_ref;
126         struct list_head        se_hash;        /* hash by sessionid */
127         struct list_head        se_perclnt;
128         u32                     se_flags;
129         struct nfs4_client      *se_client;     /* for expire_client */
130         struct nfs4_sessionid   se_sessionid;
131         u32                     se_fmaxreq_sz;
132         u32                     se_fmaxresp_sz;
133         u32                     se_fmaxresp_cached;
134         u32                     se_fmaxops;
135         u32                     se_fnumslots;
136         struct nfsd4_slot       se_slots[];     /* forward channel slots */
137 };
138
139 static inline void
140 nfsd4_put_session(struct nfsd4_session *ses)
141 {
142         extern void free_session(struct kref *kref);
143         kref_put(&ses->se_ref, free_session);
144 }
145
146 static inline void
147 nfsd4_get_session(struct nfsd4_session *ses)
148 {
149         kref_get(&ses->se_ref);
150 }
151
152 /* formatted contents of nfs4_sessionid */
153 struct nfsd4_sessionid {
154         clientid_t      clientid;
155         u32             sequence;
156         u32             reserved;
157 };
158
159 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
160
161 /*
162  * struct nfs4_client - one per client.  Clientids live here.
163  *      o Each nfs4_client is hashed by clientid.
164  *
165  *      o Each nfs4_clients is also hashed by name 
166  *        (the opaque quantity initially sent by the client to identify itself).
167  *        
168  *      o cl_perclient list is used to ensure no dangling stateowner references
169  *        when we expire the nfs4_client
170  */
171 struct nfs4_client {
172         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
173         struct list_head        cl_strhash;     /* hash by cl_name */
174         struct list_head        cl_openowners;
175         struct list_head        cl_delegations;
176         struct list_head        cl_lru;         /* tail queue */
177         struct xdr_netobj       cl_name;        /* id generated by client */
178         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
179         nfs4_verifier           cl_verifier;    /* generated by client */
180         time_t                  cl_time;        /* time of last lease renewal */
181         __be32                  cl_addr;        /* client ipaddress */
182         u32                     cl_flavor;      /* setclientid pseudoflavor */
183         char                    *cl_principal;  /* setclientid principal name */
184         struct svc_cred         cl_cred;        /* setclientid principal */
185         clientid_t              cl_clientid;    /* generated by server */
186         nfs4_verifier           cl_confirm;     /* generated by server */
187         struct nfs4_callback    cl_callback;    /* callback info */
188         atomic_t                cl_count;       /* ref count */
189         u32                     cl_firststate;  /* recovery dir creation */
190
191         /* for nfs41 */
192         struct list_head        cl_sessions;
193         struct nfsd4_slot       cl_slot;        /* create_session slot */
194         u32                     cl_exchange_flags;
195         struct nfs4_sessionid   cl_sessionid;
196 };
197
198 /* struct nfs4_client_reset
199  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
200  * upon lease reset, or from upcall to state_daemon (to read in state
201  * from non-volitile storage) upon reboot.
202  */
203 struct nfs4_client_reclaim {
204         struct list_head        cr_strhash;     /* hash by cr_name */
205         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
206 };
207
208 static inline void
209 update_stateid(stateid_t *stateid)
210 {
211         stateid->si_generation++;
212 }
213
214 /* A reasonable value for REPLAY_ISIZE was estimated as follows:  
215  * The OPEN response, typically the largest, requires 
216  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
217  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
218  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
219  */
220
221 #define NFSD4_REPLAY_ISIZE       112 
222
223 /*
224  * Replay buffer, where the result of the last seqid-mutating operation 
225  * is cached. 
226  */
227 struct nfs4_replay {
228         __be32                  rp_status;
229         unsigned int            rp_buflen;
230         char                    *rp_buf;
231         unsigned                intrp_allocated;
232         struct knfsd_fh         rp_openfh;
233         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
234 };
235
236 /*
237 * nfs4_stateowner can either be an open_owner, or a lock_owner
238 *
239 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
240 *         for lock_owner
241 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
242 *         for lock_owner
243 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
244 *         struct is reaped.
245 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock) 
246 *         and is used to ensure no dangling nfs4_stateid references when we 
247 *         release a stateowner.
248 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
249 *         close is called to reap associated byte-range locks
250 *    so_close_lru: (open) stateowner is placed on this list instead of being
251 *         reaped (when so_perfilestate is empty) to hold the last close replay.
252 *         reaped by laundramat thread after lease period.
253 */
254 struct nfs4_stateowner {
255         struct kref             so_ref;
256         struct list_head        so_idhash;   /* hash by so_id */
257         struct list_head        so_strhash;   /* hash by op_name */
258         struct list_head        so_perclient;
259         struct list_head        so_stateids;
260         struct list_head        so_perstateid; /* for lockowners only */
261         struct list_head        so_close_lru; /* tail queue */
262         time_t                  so_time; /* time of placement on so_close_lru */
263         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
264         u32                     so_id;
265         struct nfs4_client *    so_client;
266         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
267          * sequence id expected from the client: */
268         u32                     so_seqid;
269         struct xdr_netobj       so_owner;     /* open owner name */
270         int                     so_confirmed; /* successful OPEN_CONFIRM? */
271         struct nfs4_replay      so_replay;
272 };
273
274 /*
275 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
276 *    o fi_perfile list is used to search for conflicting 
277 *      share_acces, share_deny on the file.
278 */
279 struct nfs4_file {
280         atomic_t                fi_ref;
281         struct list_head        fi_hash;    /* hash by "struct inode *" */
282         struct list_head        fi_stateids;
283         struct list_head        fi_delegations;
284         struct inode            *fi_inode;
285         u32                     fi_id;      /* used with stateowner->so_id 
286                                              * for stateid_hashtbl hash */
287         bool                    fi_had_conflict;
288 };
289
290 /*
291 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
292 *
293 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
294 *
295 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
296 *       st_perfile: file_hashtbl[] entry.
297 *       st_perfile_state: nfs4_stateowner->so_perfilestate
298 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
299 *       st_access_bmap: used only for open stateid
300 *       st_deny_bmap: used only for open stateid
301 *       st_openstp: open stateid lock stateid was derived from
302 *
303 * XXX: open stateids and lock stateids have diverged sufficiently that
304 * we should consider defining separate structs for the two cases.
305 */
306
307 struct nfs4_stateid {
308         struct list_head              st_hash; 
309         struct list_head              st_perfile;
310         struct list_head              st_perstateowner;
311         struct list_head              st_lockowners;
312         struct nfs4_stateowner      * st_stateowner;
313         struct nfs4_file            * st_file;
314         stateid_t                     st_stateid;
315         struct file                 * st_vfs_file;
316         unsigned long                 st_access_bmap;
317         unsigned long                 st_deny_bmap;
318         struct nfs4_stateid         * st_openstp;
319 };
320
321 /* flags for preprocess_seqid_op() */
322 #define HAS_SESSION             0x00000001
323 #define CONFIRM                 0x00000002
324 #define OPEN_STATE              0x00000004
325 #define LOCK_STATE              0x00000008
326 #define RD_STATE                0x00000010
327 #define WR_STATE                0x00000020
328 #define CLOSE_STATE             0x00000040
329
330 #define seqid_mutating_err(err)                       \
331         (((err) != nfserr_stale_clientid) &&    \
332         ((err) != nfserr_bad_seqid) &&          \
333         ((err) != nfserr_stale_stateid) &&      \
334         ((err) != nfserr_bad_stateid))
335
336 struct nfsd4_compound_state;
337
338 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
339                 stateid_t *stateid, int flags, struct file **filp);
340 extern void nfs4_lock_state(void);
341 extern void nfs4_unlock_state(void);
342 extern int nfs4_in_grace(void);
343 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
344 extern void put_nfs4_client(struct nfs4_client *clp);
345 extern void nfs4_free_stateowner(struct kref *kref);
346 extern void nfsd4_probe_callback(struct nfs4_client *clp);
347 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
348 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
349 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
350 extern void nfsd4_init_recdir(char *recdir_name);
351 extern int nfsd4_recdir_load(void);
352 extern void nfsd4_shutdown_recdir(void);
353 extern int nfs4_client_to_reclaim(const char *name);
354 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
355 extern void nfsd4_recdir_purge_old(void);
356 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
357 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
358
359 static inline void
360 nfs4_put_stateowner(struct nfs4_stateowner *so)
361 {
362         kref_put(&so->so_ref, nfs4_free_stateowner);
363 }
364
365 static inline void
366 nfs4_get_stateowner(struct nfs4_stateowner *so)
367 {
368         kref_get(&so->so_ref);
369 }
370
371 #endif   /* NFSD4_STATE_H */