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>
21 #include <linux/module.h>
22 #include <linux/mount.h>
24 #define NLMDBG_FACILITY NLMDBG_SVCSUBS
28 * Global file hash table
30 #define FILE_HASH_BITS 7
31 #define FILE_NRHASH (1<<FILE_HASH_BITS)
32 static struct hlist_head nlm_files[FILE_NRHASH];
33 static DEFINE_MUTEX(nlm_file_mutex);
36 static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
38 u32 *fhp = (u32*)f->data;
40 /* print the first 32 bytes of the fh */
41 dprintk("lockd: %s (%08x %08x %08x %08x %08x %08x %08x %08x)\n",
42 msg, fhp[0], fhp[1], fhp[2], fhp[3],
43 fhp[4], fhp[5], fhp[6], fhp[7]);
46 static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
48 struct inode *inode = file->f_file->f_path.dentry->d_inode;
50 dprintk("lockd: %s %s/%ld\n",
51 msg, inode->i_sb->s_id, inode->i_ino);
54 static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
59 static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
65 static inline unsigned int file_hash(struct nfs_fh *f)
69 for (i=0; i<NFS2_FHSIZE;i++)
71 return tmp & (FILE_NRHASH - 1);
75 * Lookup file info. If it doesn't exist, create a file info struct
76 * and open a (VFS) file for the given inode.
79 * Note that we open the file O_RDONLY even when creating write locks.
80 * This is not quite right, but for now, we assume the client performs
81 * the proper R/W checking.
84 nlm_lookup_file(struct svc_rqst *rqstp, struct nlm_file **result,
87 struct hlist_node *pos;
88 struct nlm_file *file;
92 nlm_debug_print_fh("nlm_lookup_file", f);
97 mutex_lock(&nlm_file_mutex);
99 hlist_for_each_entry(file, pos, &nlm_files[hash], f_list)
100 if (!nfs_compare_fh(&file->f_handle, f))
103 nlm_debug_print_fh("creating file for", f);
105 nfserr = nlm_lck_denied_nolocks;
106 file = kzalloc(sizeof(*file), GFP_KERNEL);
110 memcpy(&file->f_handle, f, sizeof(struct nfs_fh));
111 mutex_init(&file->f_mutex);
112 INIT_HLIST_NODE(&file->f_list);
113 INIT_LIST_HEAD(&file->f_blocks);
115 /* Open the file. Note that this must not sleep for too long, else
116 * we would lock up lockd:-) So no NFS re-exports, folks.
118 * We have to make sure we have the right credential to open
121 if ((nfserr = nlmsvc_ops->fopen(rqstp, f, &file->f_file)) != 0) {
122 dprintk("lockd: open failed (error %d)\n", nfserr);
126 hlist_add_head(&file->f_list, &nlm_files[hash]);
129 dprintk("lockd: found file %p (count %d)\n", file, file->f_count);
135 mutex_unlock(&nlm_file_mutex);
144 * Delete a file after having released all locks, blocks and shares
147 nlm_delete_file(struct nlm_file *file)
149 nlm_debug_print_file("closing file", file);
150 if (!hlist_unhashed(&file->f_list)) {
151 hlist_del(&file->f_list);
152 nlmsvc_ops->fclose(file->f_file);
155 printk(KERN_WARNING "lockd: attempt to release unknown file!\n");
160 * Loop over all locks on the given file and perform the specified
164 nlm_traverse_locks(struct nlm_host *host, struct nlm_file *file,
165 nlm_host_match_fn_t match)
167 struct inode *inode = nlmsvc_file_inode(file);
168 struct file_lock *fl;
169 struct nlm_host *lockhost;
173 for (fl = inode->i_flock; fl; fl = fl->fl_next) {
174 if (fl->fl_lmops != &nlmsvc_lock_operations)
177 /* update current lock count */
180 lockhost = (struct nlm_host *) fl->fl_owner;
181 if (match(lockhost, host)) {
182 struct file_lock lock = *fl;
184 lock.fl_type = F_UNLCK;
186 lock.fl_end = OFFSET_MAX;
187 if (vfs_lock_file(file->f_file, F_SETLK, &lock, NULL) < 0) {
188 printk("lockd: unlock failure in %s:%d\n",
200 nlmsvc_always_match(void *dummy1, struct nlm_host *dummy2)
206 * Inspect a single file
209 nlm_inspect_file(struct nlm_host *host, struct nlm_file *file, nlm_host_match_fn_t match)
211 nlmsvc_traverse_blocks(host, file, match);
212 nlmsvc_traverse_shares(host, file, match);
213 return nlm_traverse_locks(host, file, match);
217 * Quick check whether there are still any locks, blocks or
218 * shares on a given file.
221 nlm_file_inuse(struct nlm_file *file)
223 struct inode *inode = nlmsvc_file_inode(file);
224 struct file_lock *fl;
226 if (file->f_count || !list_empty(&file->f_blocks) || file->f_shares)
229 for (fl = inode->i_flock; fl; fl = fl->fl_next) {
230 if (fl->fl_lmops == &nlmsvc_lock_operations)
238 * Loop over all files in the file table.
241 nlm_traverse_files(void *data, nlm_host_match_fn_t match,
242 int (*is_failover_file)(void *data, struct nlm_file *file))
244 struct hlist_node *pos, *next;
245 struct nlm_file *file;
248 mutex_lock(&nlm_file_mutex);
249 for (i = 0; i < FILE_NRHASH; i++) {
250 hlist_for_each_entry_safe(file, pos, next, &nlm_files[i], f_list) {
251 if (is_failover_file && !is_failover_file(data, file))
254 mutex_unlock(&nlm_file_mutex);
256 /* Traverse locks, blocks and shares of this file
257 * and update file->f_locks count */
258 if (nlm_inspect_file(data, file, match))
261 mutex_lock(&nlm_file_mutex);
263 /* No more references to this file. Let go of it. */
264 if (list_empty(&file->f_blocks) && !file->f_locks
265 && !file->f_shares && !file->f_count) {
266 hlist_del(&file->f_list);
267 nlmsvc_ops->fclose(file->f_file);
272 mutex_unlock(&nlm_file_mutex);
277 * Release file. If there are no more remote locks on this file,
278 * close it and free the handle.
280 * Note that we can't do proper reference counting without major
281 * contortions because the code in fs/locks.c creates, deletes and
282 * splits locks without notification. Our only way is to walk the
283 * entire lock list each time we remove a lock.
286 nlm_release_file(struct nlm_file *file)
288 dprintk("lockd: nlm_release_file(%p, ct = %d)\n",
289 file, file->f_count);
291 /* Lock file table */
292 mutex_lock(&nlm_file_mutex);
294 /* If there are no more locks etc, delete the file */
295 if (--file->f_count == 0 && !nlm_file_inuse(file))
296 nlm_delete_file(file);
298 mutex_unlock(&nlm_file_mutex);
302 * Helpers function for resource traversal
305 * used by the garbage collector; simply sets h_inuse.
309 * returns 1 iff the two hosts match. Used to release
310 * all resources bound to a specific host.
313 * returns 1 iff the host is a client.
314 * Used by nlmsvc_invalidate_all
317 nlmsvc_mark_host(void *data, struct nlm_host *dummy)
319 struct nlm_host *host = data;
326 nlmsvc_same_host(void *data, struct nlm_host *other)
328 struct nlm_host *host = data;
330 return host == other;
334 nlmsvc_is_client(void *data, struct nlm_host *dummy)
336 struct nlm_host *host = data;
338 if (host->h_server) {
339 /* we are destroying locks even though the client
340 * hasn't asked us too, so don't unmonitor the
343 if (host->h_nsmhandle)
344 host->h_nsmhandle->sm_sticky = 1;
351 * Mark all hosts that still hold resources
354 nlmsvc_mark_resources(void)
356 dprintk("lockd: nlmsvc_mark_resources\n");
357 nlm_traverse_files(NULL, nlmsvc_mark_host, NULL);
361 * Release all resources held by the given client
364 nlmsvc_free_host_resources(struct nlm_host *host)
366 dprintk("lockd: nlmsvc_free_host_resources\n");
368 if (nlm_traverse_files(host, nlmsvc_same_host, NULL)) {
370 "lockd: couldn't remove all locks held by %s\n",
377 * Remove all locks held for clients
380 nlmsvc_invalidate_all(void)
382 /* Release all locks held by NFS clients.
383 * Previously, the code would call
384 * nlmsvc_free_host_resources for each client in
385 * turn, which is about as inefficient as it gets.
386 * Now we just do it once in nlm_traverse_files.
388 nlm_traverse_files(NULL, nlmsvc_is_client, NULL);
392 nlmsvc_match_sb(void *datap, struct nlm_file *file)
394 struct super_block *sb = datap;
396 return sb == file->f_file->f_path.mnt->mnt_sb;
400 nlmsvc_unlock_all_by_sb(struct super_block *sb)
404 ret = nlm_traverse_files(sb, nlmsvc_always_match, nlmsvc_match_sb);
405 return ret ? -EIO : 0;
407 EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_sb);
410 nlmsvc_match_ip(void *datap, struct nlm_host *host)
412 __be32 *server_addr = datap;
414 return host->h_saddr.sin_addr.s_addr == *server_addr;
418 nlmsvc_unlock_all_by_ip(__be32 server_addr)
421 ret = nlm_traverse_files(&server_addr, nlmsvc_match_ip, NULL);
422 return ret ? -EIO : 0;
425 EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_ip);