[PATCH] knfsd: nfsd4: make needlessly global code static
[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 #define NFS4_OPAQUE_LIMIT 1024
45 typedef struct {
46         u32             cl_boot;
47         u32             cl_id;
48 } clientid_t;
49
50 typedef struct {
51         u32             so_boot;
52         u32             so_stateownerid;
53         u32             so_fileid;
54 } stateid_opaque_t;
55
56 typedef struct {
57         u32                     si_generation;
58         stateid_opaque_t        si_opaque;
59 } stateid_t;
60 #define si_boot           si_opaque.so_boot
61 #define si_stateownerid   si_opaque.so_stateownerid
62 #define si_fileid         si_opaque.so_fileid
63
64
65 struct nfs4_cb_recall {
66         u32                     cbr_ident;
67         int                     cbr_trunc;
68         stateid_t               cbr_stateid;
69         u32                     cbr_fhlen;
70         u32                     cbr_fhval[NFS4_FHSIZE];
71         struct nfs4_delegation  *cbr_dp;
72 };
73
74 struct nfs4_delegation {
75         struct list_head        dl_del_perfile; /* nfs4_file->fi_del_perfile */
76         struct list_head        dl_del_perclnt; /* nfs4_client->cl_del_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         struct nfs4_cb_recall   dl_recall;
86 };
87
88 #define dl_stateid      dl_recall.cbr_stateid
89 #define dl_fhlen        dl_recall.cbr_fhlen
90 #define dl_fhval        dl_recall.cbr_fhval
91
92 /* client delegation callback info */
93 struct nfs4_callback {
94         /* SETCLIENTID info */
95         u32                     cb_parsed;  /* addr parsed */
96         u32                     cb_addr;
97         unsigned short          cb_port;
98         u32                     cb_prog;
99         u32                     cb_ident;
100         /* RPC client info */
101         atomic_t                cb_set;     /* successful CB_NULL call */
102         struct rpc_program      cb_program;
103         struct rpc_stat         cb_stat;
104         struct rpc_clnt *       cb_client;
105 };
106
107 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
108
109 /*
110  * struct nfs4_client - one per client.  Clientids live here.
111  *      o Each nfs4_client is hashed by clientid.
112  *
113  *      o Each nfs4_clients is also hashed by name 
114  *        (the opaque quantity initially sent by the client to identify itself).
115  *        
116  *      o cl_perclient list is used to ensure no dangling stateowner references
117  *        when we expire the nfs4_client
118  */
119 struct nfs4_client {
120         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
121         struct list_head        cl_strhash;     /* hash by cl_name */
122         struct list_head        cl_perclient;   /* list: stateowners */
123         struct list_head        cl_del_perclnt; /* list: delegations */
124         struct list_head        cl_lru;         /* tail queue */
125         struct xdr_netobj       cl_name;        /* id generated by client */
126         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
127         nfs4_verifier           cl_verifier;    /* generated by client */
128         time_t                  cl_time;        /* time of last lease renewal */
129         u32                     cl_addr;        /* client ipaddress */
130         struct svc_cred         cl_cred;        /* setclientid principal */
131         clientid_t              cl_clientid;    /* generated by server */
132         nfs4_verifier           cl_confirm;     /* generated by server */
133         struct nfs4_callback    cl_callback;    /* callback info */
134         atomic_t                cl_count;       /* ref count */
135 };
136
137 /* struct nfs4_client_reset
138  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
139  * upon lease reset, or from upcall to state_daemon (to read in state
140  * from non-volitile storage) upon reboot.
141  */
142 struct nfs4_client_reclaim {
143         struct list_head        cr_strhash;     /* hash by cr_name */
144         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
145 };
146
147 static inline void
148 update_stateid(stateid_t *stateid)
149 {
150         stateid->si_generation++;
151 }
152
153 /* A reasonable value for REPLAY_ISIZE was estimated as follows:  
154  * The OPEN response, typically the largest, requires 
155  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
156  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
157  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
158  */
159
160 #define NFSD4_REPLAY_ISIZE       112 
161
162 /*
163  * Replay buffer, where the result of the last seqid-mutating operation 
164  * is cached. 
165  */
166 struct nfs4_replay {
167         u32                     rp_status;
168         unsigned int            rp_buflen;
169         char                    *rp_buf;
170         unsigned                intrp_allocated;
171         int                     rp_openfh_len;
172         char                    rp_openfh[NFS4_FHSIZE];
173         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
174 };
175
176 /*
177 * nfs4_stateowner can either be an open_owner, or a lock_owner
178 *
179 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
180 *         for lock_owner
181 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
182 *         for lock_owner
183 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
184 *         struct is reaped.
185 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock) 
186 *         and is used to ensure no dangling nfs4_stateid references when we 
187 *         release a stateowner.
188 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
189 *         close is called to reap associated byte-range locks
190 *    so_close_lru: (open) stateowner is placed on this list instead of being
191 *         reaped (when so_perfilestate is empty) to hold the last close replay.
192 *         reaped by laundramat thread after lease period.
193 */
194 struct nfs4_stateowner {
195         struct kref             so_ref;
196         struct list_head        so_idhash;   /* hash by so_id */
197         struct list_head        so_strhash;   /* hash by op_name */
198         struct list_head        so_perclient; /* nfs4_client->cl_perclient */
199         struct list_head        so_perfilestate; /* list: nfs4_stateid */
200         struct list_head        so_perlockowner; /* nfs4_stateid->st_perlockowner */
201         struct list_head        so_close_lru; /* tail queue */
202         time_t                  so_time; /* time of placement on so_close_lru */
203         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
204         u32                     so_id;
205         struct nfs4_client *    so_client;
206         u32                     so_seqid;    
207         struct xdr_netobj       so_owner;     /* open owner name */
208         int                     so_confirmed; /* successful OPEN_CONFIRM? */
209         struct nfs4_replay      so_replay;
210 };
211
212 /*
213 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
214 *    o fi_perfile list is used to search for conflicting 
215 *      share_acces, share_deny on the file.
216 */
217 struct nfs4_file {
218         struct kref             fi_ref;
219         struct list_head        fi_hash;    /* hash by "struct inode *" */
220         struct list_head        fi_stateids;
221         struct list_head        fi_delegations;
222         struct inode            *fi_inode;
223         u32                     fi_id;      /* used with stateowner->so_id 
224                                              * for stateid_hashtbl hash */
225 };
226
227 /*
228 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
229 *
230 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
231 *
232 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
233 *       st_perfile: file_hashtbl[] entry.
234 *       st_perfile_state: nfs4_stateowner->so_perfilestate
235 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
236 *       st_access_bmap: used only for open stateid
237 *       st_deny_bmap: used only for open stateid
238 */
239
240 struct nfs4_stateid {
241         struct list_head              st_hash; 
242         struct list_head              st_perfile;
243         struct list_head              st_perfilestate; 
244         struct list_head              st_perlockowner;
245         struct nfs4_stateowner      * st_stateowner;
246         struct nfs4_file            * st_file;
247         stateid_t                     st_stateid;
248         struct file                 * st_vfs_file;
249         unsigned long                 st_access_bmap;
250         unsigned long                 st_deny_bmap;
251 };
252
253 /* flags for preprocess_seqid_op() */
254 #define CHECK_FH                0x00000001
255 #define CONFIRM                 0x00000002
256 #define OPEN_STATE              0x00000004
257 #define LOCK_STATE              0x00000008
258 #define RD_STATE                0x00000010
259 #define WR_STATE                0x00000020
260 #define CLOSE_STATE             0x00000040
261 #define DELEG_RET               0x00000080
262
263 #define seqid_mutating_err(err)                       \
264         (((err) != nfserr_stale_clientid) &&    \
265         ((err) != nfserr_bad_seqid) &&          \
266         ((err) != nfserr_stale_stateid) &&      \
267         ((err) != nfserr_bad_stateid))
268
269 extern int nfsd4_renew(clientid_t *clid);
270 extern int nfs4_preprocess_stateid_op(struct svc_fh *current_fh, 
271                 stateid_t *stateid, int flags, struct file **filp);
272 extern void nfs4_lock_state(void);
273 extern void nfs4_unlock_state(void);
274 extern int nfs4_in_grace(void);
275 extern int nfs4_check_open_reclaim(clientid_t *clid);
276 extern void put_nfs4_client(struct nfs4_client *clp);
277 extern void nfs4_free_stateowner(struct kref *kref);
278 extern void nfsd4_probe_callback(struct nfs4_client *clp);
279 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
280 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
281 extern int nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
282
283 static inline void
284 nfs4_put_stateowner(struct nfs4_stateowner *so)
285 {
286         kref_put(&so->so_ref, nfs4_free_stateowner);
287 }
288
289 static inline void
290 nfs4_get_stateowner(struct nfs4_stateowner *so)
291 {
292         kref_get(&so->so_ref);
293 }
294
295 #endif   /* NFSD4_STATE_H */