2 * linux/fs/lockd/svcsubs.c
4 * Various support routines for the NLM server.
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
9 #include <linux/types.h>
10 #include <linux/string.h>
11 #include <linux/time.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>
22 #define NLMDBG_FACILITY NLMDBG_SVCSUBS
26 * Global file hash table
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);
34 static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
36 u32 *fhp = (u32*)f->data;
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]);
44 static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
46 struct inode *inode = file->f_file->f_path.dentry->d_inode;
48 dprintk("lockd: %s %s/%ld\n",
49 msg, inode->i_sb->s_id, inode->i_ino);
52 static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
57 static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
63 static inline unsigned int file_hash(struct nfs_fh *f)
67 for (i=0; i<NFS2_FHSIZE;i++)
69 return tmp & (FILE_NRHASH - 1);
73 * Lookup file info. If it doesn't exist, create a file info struct
74 * and open a (VFS) file for the given inode.
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.
82 nlm_lookup_file(struct svc_rqst *rqstp, struct nlm_file **result,
85 struct hlist_node *pos;
86 struct nlm_file *file;
90 nlm_debug_print_fh("nlm_lookup_file", f);
95 mutex_lock(&nlm_file_mutex);
97 hlist_for_each_entry(file, pos, &nlm_files[hash], f_list)
98 if (!nfs_compare_fh(&file->f_handle, f))
101 nlm_debug_print_fh("creating file for", f);
103 nfserr = nlm_lck_denied_nolocks;
104 file = kzalloc(sizeof(*file), GFP_KERNEL);
108 memcpy(&file->f_handle, f, sizeof(struct nfs_fh));
109 mutex_init(&file->f_mutex);
110 INIT_HLIST_NODE(&file->f_list);
111 INIT_LIST_HEAD(&file->f_blocks);
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.
116 * We have to make sure we have the right credential to open
119 if ((nfserr = nlmsvc_ops->fopen(rqstp, f, &file->f_file)) != 0) {
120 dprintk("lockd: open failed (error %d)\n", nfserr);
124 hlist_add_head(&file->f_list, &nlm_files[hash]);
127 dprintk("lockd: found file %p (count %d)\n", file, file->f_count);
133 mutex_unlock(&nlm_file_mutex);
142 * Delete a file after having released all locks, blocks and shares
145 nlm_delete_file(struct nlm_file *file)
147 nlm_debug_print_file("closing file", file);
148 if (!hlist_unhashed(&file->f_list)) {
149 hlist_del(&file->f_list);
150 nlmsvc_ops->fclose(file->f_file);
153 printk(KERN_WARNING "lockd: attempt to release unknown file!\n");
158 * Loop over all locks on the given file and perform the specified
162 nlm_traverse_locks(struct nlm_host *host, struct nlm_file *file,
163 nlm_host_match_fn_t match)
165 struct inode *inode = nlmsvc_file_inode(file);
166 struct file_lock *fl;
167 struct nlm_host *lockhost;
171 for (fl = inode->i_flock; fl; fl = fl->fl_next) {
172 if (fl->fl_lmops != &nlmsvc_lock_operations)
175 /* update current lock count */
178 lockhost = (struct nlm_host *) fl->fl_owner;
179 if (match(lockhost, host)) {
180 struct file_lock lock = *fl;
182 lock.fl_type = F_UNLCK;
184 lock.fl_end = OFFSET_MAX;
185 if (vfs_lock_file(file->f_file, F_SETLK, &lock, NULL) < 0) {
186 printk("lockd: unlock failure in %s:%d\n",
198 * Inspect a single file
201 nlm_inspect_file(struct nlm_host *host, struct nlm_file *file, nlm_host_match_fn_t match)
203 nlmsvc_traverse_blocks(host, file, match);
204 nlmsvc_traverse_shares(host, file, match);
205 return nlm_traverse_locks(host, file, match);
209 * Quick check whether there are still any locks, blocks or
210 * shares on a given file.
213 nlm_file_inuse(struct nlm_file *file)
215 struct inode *inode = nlmsvc_file_inode(file);
216 struct file_lock *fl;
218 if (file->f_count || !list_empty(&file->f_blocks) || file->f_shares)
221 for (fl = inode->i_flock; fl; fl = fl->fl_next) {
222 if (fl->fl_lmops == &nlmsvc_lock_operations)
230 * Loop over all files in the file table.
233 nlm_traverse_files(struct nlm_host *host, nlm_host_match_fn_t match)
235 struct hlist_node *pos, *next;
236 struct nlm_file *file;
239 mutex_lock(&nlm_file_mutex);
240 for (i = 0; i < FILE_NRHASH; i++) {
241 hlist_for_each_entry_safe(file, pos, next, &nlm_files[i], f_list) {
243 mutex_unlock(&nlm_file_mutex);
245 /* Traverse locks, blocks and shares of this file
246 * and update file->f_locks count */
247 if (nlm_inspect_file(host, file, match))
250 mutex_lock(&nlm_file_mutex);
252 /* No more references to this file. Let go of it. */
253 if (list_empty(&file->f_blocks) && !file->f_locks
254 && !file->f_shares && !file->f_count) {
255 hlist_del(&file->f_list);
256 nlmsvc_ops->fclose(file->f_file);
261 mutex_unlock(&nlm_file_mutex);
266 * Release file. If there are no more remote locks on this file,
267 * close it and free the handle.
269 * Note that we can't do proper reference counting without major
270 * contortions because the code in fs/locks.c creates, deletes and
271 * splits locks without notification. Our only way is to walk the
272 * entire lock list each time we remove a lock.
275 nlm_release_file(struct nlm_file *file)
277 dprintk("lockd: nlm_release_file(%p, ct = %d)\n",
278 file, file->f_count);
280 /* Lock file table */
281 mutex_lock(&nlm_file_mutex);
283 /* If there are no more locks etc, delete the file */
284 if (--file->f_count == 0 && !nlm_file_inuse(file))
285 nlm_delete_file(file);
287 mutex_unlock(&nlm_file_mutex);
291 * Helpers function for resource traversal
294 * used by the garbage collector; simply sets h_inuse.
298 * returns 1 iff the two hosts match. Used to release
299 * all resources bound to a specific host.
302 * returns 1 iff the host is a client.
303 * Used by nlmsvc_invalidate_all
306 nlmsvc_mark_host(struct nlm_host *host, struct nlm_host *dummy)
313 nlmsvc_same_host(struct nlm_host *host, struct nlm_host *other)
315 return host == other;
319 nlmsvc_is_client(struct nlm_host *host, struct nlm_host *dummy)
321 if (host->h_server) {
322 /* we are destroying locks even though the client
323 * hasn't asked us too, so don't unmonitor the
326 if (host->h_nsmhandle)
327 host->h_nsmhandle->sm_sticky = 1;
334 * Mark all hosts that still hold resources
337 nlmsvc_mark_resources(void)
339 dprintk("lockd: nlmsvc_mark_resources\n");
340 nlm_traverse_files(NULL, nlmsvc_mark_host);
344 * Release all resources held by the given client
347 nlmsvc_free_host_resources(struct nlm_host *host)
349 dprintk("lockd: nlmsvc_free_host_resources\n");
351 if (nlm_traverse_files(host, nlmsvc_same_host)) {
353 "lockd: couldn't remove all locks held by %s\n",
360 * Remove all locks held for clients
363 nlmsvc_invalidate_all(void)
365 /* Release all locks held by NFS clients.
366 * Previously, the code would call
367 * nlmsvc_free_host_resources for each client in
368 * turn, which is about as inefficient as it gets.
369 * Now we just do it once in nlm_traverse_files.
371 nlm_traverse_files(NULL, nlmsvc_is_client);