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