[PATCH] knfsd: change nlm_file to use a hlist
[linux-2.6.git] / fs / lockd / svcsubs.c
1 /*
2  * linux/fs/lockd/svcsubs.c
3  *
4  * Various support routines for the NLM server.
5  *
6  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7  */
8
9 #include <linux/types.h>
10 #include <linux/string.h>
11 #include <linux/time.h>
12 #include <linux/in.h>
13 #include <linux/mutex.h>
14 #include <linux/sunrpc/svc.h>
15 #include <linux/sunrpc/clnt.h>
16 #include <linux/nfsd/nfsfh.h>
17 #include <linux/nfsd/export.h>
18 #include <linux/lockd/lockd.h>
19 #include <linux/lockd/share.h>
20 #include <linux/lockd/sm_inter.h>
21
22 #define NLMDBG_FACILITY         NLMDBG_SVCSUBS
23
24
25 /*
26  * Global file hash table
27  */
28 #define FILE_HASH_BITS          7
29 #define FILE_NRHASH             (1<<FILE_HASH_BITS)
30 static struct hlist_head        nlm_files[FILE_NRHASH];
31 static DEFINE_MUTEX(nlm_file_mutex);
32
33 #ifdef NFSD_DEBUG
34 static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
35 {
36         u32 *fhp = (u32*)f->data;
37
38         /* print the first 32 bytes of the fh */
39         dprintk("lockd: %s (%08x %08x %08x %08x %08x %08x %08x %08x)\n",
40                 msg, fhp[0], fhp[1], fhp[2], fhp[3],
41                 fhp[4], fhp[5], fhp[6], fhp[7]);
42 }
43
44 static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
45 {
46         struct inode *inode = file->f_file->f_dentry->d_inode;
47
48         dprintk("lockd: %s %s/%ld\n",
49                 msg, inode->i_sb->s_id, inode->i_ino);
50 }
51 #else
52 static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
53 {
54         return;
55 }
56
57 static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
58 {
59         return;
60 }
61 #endif
62
63 static inline unsigned int file_hash(struct nfs_fh *f)
64 {
65         unsigned int tmp=0;
66         int i;
67         for (i=0; i<NFS2_FHSIZE;i++)
68                 tmp += f->data[i];
69         return tmp & (FILE_NRHASH - 1);
70 }
71
72 /*
73  * Lookup file info. If it doesn't exist, create a file info struct
74  * and open a (VFS) file for the given inode.
75  *
76  * FIXME:
77  * Note that we open the file O_RDONLY even when creating write locks.
78  * This is not quite right, but for now, we assume the client performs
79  * the proper R/W checking.
80  */
81 u32
82 nlm_lookup_file(struct svc_rqst *rqstp, struct nlm_file **result,
83                                         struct nfs_fh *f)
84 {
85         struct hlist_node *pos;
86         struct nlm_file *file;
87         unsigned int    hash;
88         u32             nfserr;
89
90         nlm_debug_print_fh("nlm_file_lookup", f);
91
92         hash = file_hash(f);
93
94         /* Lock file table */
95         mutex_lock(&nlm_file_mutex);
96
97         hlist_for_each_entry(file, pos, &nlm_files[hash], f_list)
98                 if (!nfs_compare_fh(&file->f_handle, f))
99                         goto found;
100
101         nlm_debug_print_fh("creating file for", f);
102
103         nfserr = nlm_lck_denied_nolocks;
104         file = kzalloc(sizeof(*file), GFP_KERNEL);
105         if (!file)
106                 goto out_unlock;
107
108         memcpy(&file->f_handle, f, sizeof(struct nfs_fh));
109         init_MUTEX(&file->f_sema);
110         INIT_HLIST_NODE(&file->f_list);
111         INIT_LIST_HEAD(&file->f_blocks);
112
113         /* Open the file. Note that this must not sleep for too long, else
114          * we would lock up lockd:-) So no NFS re-exports, folks.
115          *
116          * We have to make sure we have the right credential to open
117          * the file.
118          */
119         if ((nfserr = nlmsvc_ops->fopen(rqstp, f, &file->f_file)) != 0) {
120                 dprintk("lockd: open failed (error %d)\n", nfserr);
121                 goto out_free;
122         }
123
124         hlist_add_head(&file->f_list, &nlm_files[hash]);
125
126 found:
127         dprintk("lockd: found file %p (count %d)\n", file, file->f_count);
128         *result = file;
129         file->f_count++;
130         nfserr = 0;
131
132 out_unlock:
133         mutex_unlock(&nlm_file_mutex);
134         return nfserr;
135
136 out_free:
137         kfree(file);
138 #ifdef CONFIG_LOCKD_V4
139         if (nfserr == 1)
140                 nfserr = nlm4_stale_fh;
141         else
142 #endif
143         nfserr = nlm_lck_denied;
144         goto out_unlock;
145 }
146
147 /*
148  * Delete a file after having released all locks, blocks and shares
149  */
150 static inline void
151 nlm_delete_file(struct nlm_file *file)
152 {
153         nlm_debug_print_file("closing file", file);
154         if (!hlist_unhashed(&file->f_list)) {
155                 hlist_del(&file->f_list);
156                 nlmsvc_ops->fclose(file->f_file);
157                 kfree(file);
158         } else {
159                 printk(KERN_WARNING "lockd: attempt to release unknown file!\n");
160         }
161 }
162
163 /*
164  * Loop over all locks on the given file and perform the specified
165  * action.
166  */
167 static int
168 nlm_traverse_locks(struct nlm_host *host, struct nlm_file *file, int action)
169 {
170         struct inode     *inode = nlmsvc_file_inode(file);
171         struct file_lock *fl;
172         struct nlm_host  *lockhost;
173
174 again:
175         file->f_locks = 0;
176         for (fl = inode->i_flock; fl; fl = fl->fl_next) {
177                 if (fl->fl_lmops != &nlmsvc_lock_operations)
178                         continue;
179
180                 /* update current lock count */
181                 file->f_locks++;
182                 lockhost = (struct nlm_host *) fl->fl_owner;
183                 if (action == NLM_ACT_MARK)
184                         lockhost->h_inuse = 1;
185                 else if (action == NLM_ACT_CHECK)
186                         return 1;
187                 else if (action == NLM_ACT_UNLOCK) {
188                         struct file_lock lock = *fl;
189
190                         if (host && lockhost != host)
191                                 continue;
192
193                         lock.fl_type  = F_UNLCK;
194                         lock.fl_start = 0;
195                         lock.fl_end   = OFFSET_MAX;
196                         if (posix_lock_file(file->f_file, &lock) < 0) {
197                                 printk("lockd: unlock failure in %s:%d\n",
198                                                 __FILE__, __LINE__);
199                                 return 1;
200                         }
201                         goto again;
202                 }
203         }
204
205         return 0;
206 }
207
208 /*
209  * Operate on a single file
210  */
211 static inline int
212 nlm_inspect_file(struct nlm_host *host, struct nlm_file *file, int action)
213 {
214         if (action == NLM_ACT_CHECK) {
215                 /* Fast path for mark and sweep garbage collection */
216                 if (file->f_count || list_empty(&file->f_blocks) || file->f_shares)
217                         return 1;
218         } else {
219                 nlmsvc_traverse_blocks(host, file, action);
220                 nlmsvc_traverse_shares(host, file, action);
221         }
222         return nlm_traverse_locks(host, file, action);
223 }
224
225 /*
226  * Loop over all files in the file table.
227  */
228 static int
229 nlm_traverse_files(struct nlm_host *host, int action)
230 {
231         struct hlist_node *pos, *next;
232         struct nlm_file *file;
233         int i, ret = 0;
234
235         mutex_lock(&nlm_file_mutex);
236         for (i = 0; i < FILE_NRHASH; i++) {
237                 hlist_for_each_entry_safe(file, pos, next, &nlm_files[i], f_list) {
238                         file->f_count++;
239                         mutex_unlock(&nlm_file_mutex);
240
241                         /* Traverse locks, blocks and shares of this file
242                          * and update file->f_locks count */
243                         if (nlm_inspect_file(host, file, action))
244                                 ret = 1;
245
246                         mutex_lock(&nlm_file_mutex);
247                         file->f_count--;
248                         /* No more references to this file. Let go of it. */
249                         if (list_empty(&file->f_blocks) && !file->f_locks
250                          && !file->f_shares && !file->f_count) {
251                                 hlist_del(&file->f_list);
252                                 nlmsvc_ops->fclose(file->f_file);
253                                 kfree(file);
254                         }
255                 }
256         }
257         mutex_unlock(&nlm_file_mutex);
258         return ret;
259 }
260
261 /*
262  * Release file. If there are no more remote locks on this file,
263  * close it and free the handle.
264  *
265  * Note that we can't do proper reference counting without major
266  * contortions because the code in fs/locks.c creates, deletes and
267  * splits locks without notification. Our only way is to walk the
268  * entire lock list each time we remove a lock.
269  */
270 void
271 nlm_release_file(struct nlm_file *file)
272 {
273         dprintk("lockd: nlm_release_file(%p, ct = %d)\n",
274                                 file, file->f_count);
275
276         /* Lock file table */
277         mutex_lock(&nlm_file_mutex);
278
279         /* If there are no more locks etc, delete the file */
280         if(--file->f_count == 0) {
281                 if(!nlm_inspect_file(NULL, file, NLM_ACT_CHECK))
282                         nlm_delete_file(file);
283         }
284
285         mutex_unlock(&nlm_file_mutex);
286 }
287
288 /*
289  * Mark all hosts that still hold resources
290  */
291 void
292 nlmsvc_mark_resources(void)
293 {
294         dprintk("lockd: nlmsvc_mark_resources\n");
295
296         nlm_traverse_files(NULL, NLM_ACT_MARK);
297 }
298
299 /*
300  * Release all resources held by the given client
301  */
302 void
303 nlmsvc_free_host_resources(struct nlm_host *host)
304 {
305         dprintk("lockd: nlmsvc_free_host_resources\n");
306
307         if (nlm_traverse_files(host, NLM_ACT_UNLOCK)) {
308                 printk(KERN_WARNING
309                         "lockd: couldn't remove all locks held by %s\n",
310                         host->h_name);
311                 BUG();
312         }
313 }
314
315 /*
316  * delete all hosts structs for clients
317  */
318 void
319 nlmsvc_invalidate_all(void)
320 {
321         struct nlm_host *host;
322         while ((host = nlm_find_client()) != NULL) {
323                 nlmsvc_free_host_resources(host);
324                 host->h_expires = 0;
325                 host->h_killed = 1;
326                 nlm_release_host(host);
327         }
328 }