]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/lockd/svcsubs.c
Merge tag 'mmc-v4.15-2' of git://git.kernel.org/pub/scm/linux/kernel/git/ulfh/mmc
[mirror_ubuntu-bionic-kernel.git] / fs / lockd / svcsubs.c
CommitLineData
1da177e4
LT
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
1da177e4
LT
9#include <linux/types.h>
10#include <linux/string.h>
11#include <linux/time.h>
12#include <linux/in.h>
5a0e3ad6 13#include <linux/slab.h>
353ab6e9 14#include <linux/mutex.h>
1da177e4 15#include <linux/sunrpc/svc.h>
5976687a 16#include <linux/sunrpc/addr.h>
1da177e4
LT
17#include <linux/lockd/lockd.h>
18#include <linux/lockd/share.h>
4373ea84
WC
19#include <linux/module.h>
20#include <linux/mount.h>
9c69de4c 21#include <uapi/linux/nfs2.h>
1da177e4
LT
22
23#define NLMDBG_FACILITY NLMDBG_SVCSUBS
24
25
26/*
27 * Global file hash table
28 */
07ba8063 29#define FILE_HASH_BITS 7
1da177e4 30#define FILE_NRHASH (1<<FILE_HASH_BITS)
07ba8063 31static struct hlist_head nlm_files[FILE_NRHASH];
353ab6e9 32static DEFINE_MUTEX(nlm_file_mutex);
1da177e4 33
135dd002 34#ifdef CONFIG_SUNRPC_DEBUG
0bbacc40
CL
35static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
36{
37 u32 *fhp = (u32*)f->data;
38
39 /* print the first 32 bytes of the fh */
40 dprintk("lockd: %s (%08x %08x %08x %08x %08x %08x %08x %08x)\n",
41 msg, fhp[0], fhp[1], fhp[2], fhp[3],
42 fhp[4], fhp[5], fhp[6], fhp[7]);
43}
44
45static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
46{
496ad9aa 47 struct inode *inode = file_inode(file->f_file);
0bbacc40
CL
48
49 dprintk("lockd: %s %s/%ld\n",
50 msg, inode->i_sb->s_id, inode->i_ino);
51}
52#else
53static inline void nlm_debug_print_fh(char *msg, struct nfs_fh *f)
54{
55 return;
56}
57
58static inline void nlm_debug_print_file(char *msg, struct nlm_file *file)
59{
60 return;
61}
62#endif
63
1da177e4
LT
64static inline unsigned int file_hash(struct nfs_fh *f)
65{
66 unsigned int tmp=0;
67 int i;
68 for (i=0; i<NFS2_FHSIZE;i++)
69 tmp += f->data[i];
70 return tmp & (FILE_NRHASH - 1);
71}
72
73/*
74 * Lookup file info. If it doesn't exist, create a file info struct
75 * and open a (VFS) file for the given inode.
76 *
77 * FIXME:
78 * Note that we open the file O_RDONLY even when creating write locks.
79 * This is not quite right, but for now, we assume the client performs
80 * the proper R/W checking.
81 */
52921e02 82__be32
1da177e4
LT
83nlm_lookup_file(struct svc_rqst *rqstp, struct nlm_file **result,
84 struct nfs_fh *f)
85{
86 struct nlm_file *file;
87 unsigned int hash;
52921e02 88 __be32 nfserr;
1da177e4 89
50431d94 90 nlm_debug_print_fh("nlm_lookup_file", f);
1da177e4
LT
91
92 hash = file_hash(f);
93
94 /* Lock file table */
353ab6e9 95 mutex_lock(&nlm_file_mutex);
1da177e4 96
b67bfe0d 97 hlist_for_each_entry(file, &nlm_files[hash], f_list)
1da177e4
LT
98 if (!nfs_compare_fh(&file->f_handle, f))
99 goto found;
100
0bbacc40 101 nlm_debug_print_fh("creating file for", f);
1da177e4
LT
102
103 nfserr = nlm_lck_denied_nolocks;
f8314dc6 104 file = kzalloc(sizeof(*file), GFP_KERNEL);
1da177e4
LT
105 if (!file)
106 goto out_unlock;
107
1da177e4 108 memcpy(&file->f_handle, f, sizeof(struct nfs_fh));
89e63ef6 109 mutex_init(&file->f_mutex);
07ba8063 110 INIT_HLIST_NODE(&file->f_list);
68a2d76c 111 INIT_LIST_HEAD(&file->f_blocks);
1da177e4
LT
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) {
f0737a39 120 dprintk("lockd: open failed (error %d)\n", nfserr);
1da177e4
LT
121 goto out_free;
122 }
123
07ba8063 124 hlist_add_head(&file->f_list, &nlm_files[hash]);
1da177e4
LT
125
126found:
127 dprintk("lockd: found file %p (count %d)\n", file, file->f_count);
128 *result = file;
129 file->f_count++;
130 nfserr = 0;
131
132out_unlock:
353ab6e9 133 mutex_unlock(&nlm_file_mutex);
1da177e4
LT
134 return nfserr;
135
136out_free:
137 kfree(file);
1da177e4
LT
138 goto out_unlock;
139}
140
141/*
142 * Delete a file after having released all locks, blocks and shares
143 */
144static inline void
145nlm_delete_file(struct nlm_file *file)
146{
0bbacc40 147 nlm_debug_print_file("closing file", file);
07ba8063
OK
148 if (!hlist_unhashed(&file->f_list)) {
149 hlist_del(&file->f_list);
150 nlmsvc_ops->fclose(file->f_file);
151 kfree(file);
152 } else {
153 printk(KERN_WARNING "lockd: attempt to release unknown file!\n");
1da177e4 154 }
1da177e4
LT
155}
156
157/*
158 * Loop over all locks on the given file and perform the specified
159 * action.
160 */
161static int
f2af793d
OK
162nlm_traverse_locks(struct nlm_host *host, struct nlm_file *file,
163 nlm_host_match_fn_t match)
1da177e4
LT
164{
165 struct inode *inode = nlmsvc_file_inode(file);
166 struct file_lock *fl;
bd61e0a9 167 struct file_lock_context *flctx = inode->i_flctx;
1da177e4
LT
168 struct nlm_host *lockhost;
169
bd61e0a9
JL
170 if (!flctx || list_empty_careful(&flctx->flc_posix))
171 return 0;
1da177e4
LT
172again:
173 file->f_locks = 0;
6109c850 174 spin_lock(&flctx->flc_lock);
bd61e0a9 175 list_for_each_entry(fl, &flctx->flc_posix, fl_list) {
7117bf3d 176 if (fl->fl_lmops != &nlmsvc_lock_operations)
1da177e4
LT
177 continue;
178
179 /* update current lock count */
180 file->f_locks++;
f2af793d 181
1da177e4 182 lockhost = (struct nlm_host *) fl->fl_owner;
f2af793d 183 if (match(lockhost, host)) {
1da177e4
LT
184 struct file_lock lock = *fl;
185
6109c850 186 spin_unlock(&flctx->flc_lock);
1da177e4
LT
187 lock.fl_type = F_UNLCK;
188 lock.fl_start = 0;
189 lock.fl_end = OFFSET_MAX;
1a8322b2 190 if (vfs_lock_file(file->f_file, F_SETLK, &lock, NULL) < 0) {
1da177e4
LT
191 printk("lockd: unlock failure in %s:%d\n",
192 __FILE__, __LINE__);
193 return 1;
194 }
195 goto again;
196 }
197 }
6109c850 198 spin_unlock(&flctx->flc_lock);
1da177e4
LT
199
200 return 0;
201}
202
17efa372
WC
203static int
204nlmsvc_always_match(void *dummy1, struct nlm_host *dummy2)
205{
206 return 1;
207}
208
1da177e4 209/*
f2af793d
OK
210 * Inspect a single file
211 */
212static inline int
213nlm_inspect_file(struct nlm_host *host, struct nlm_file *file, nlm_host_match_fn_t match)
214{
215 nlmsvc_traverse_blocks(host, file, match);
216 nlmsvc_traverse_shares(host, file, match);
217 return nlm_traverse_locks(host, file, match);
218}
219
220/*
221 * Quick check whether there are still any locks, blocks or
222 * shares on a given file.
1da177e4
LT
223 */
224static inline int
f2af793d 225nlm_file_inuse(struct nlm_file *file)
1da177e4 226{
f2af793d
OK
227 struct inode *inode = nlmsvc_file_inode(file);
228 struct file_lock *fl;
bd61e0a9 229 struct file_lock_context *flctx = inode->i_flctx;
f2af793d
OK
230
231 if (file->f_count || !list_empty(&file->f_blocks) || file->f_shares)
232 return 1;
233
bd61e0a9 234 if (flctx && !list_empty_careful(&flctx->flc_posix)) {
6109c850 235 spin_lock(&flctx->flc_lock);
bd61e0a9
JL
236 list_for_each_entry(fl, &flctx->flc_posix, fl_list) {
237 if (fl->fl_lmops == &nlmsvc_lock_operations) {
6109c850 238 spin_unlock(&flctx->flc_lock);
bd61e0a9
JL
239 return 1;
240 }
763641d8 241 }
6109c850 242 spin_unlock(&flctx->flc_lock);
1da177e4 243 }
f2af793d
OK
244 file->f_locks = 0;
245 return 0;
1da177e4
LT
246}
247
248/*
249 * Loop over all files in the file table.
250 */
251static int
17efa372
WC
252nlm_traverse_files(void *data, nlm_host_match_fn_t match,
253 int (*is_failover_file)(void *data, struct nlm_file *file))
1da177e4 254{
b67bfe0d 255 struct hlist_node *next;
07ba8063 256 struct nlm_file *file;
01df9c5e 257 int i, ret = 0;
1da177e4 258
353ab6e9 259 mutex_lock(&nlm_file_mutex);
1da177e4 260 for (i = 0; i < FILE_NRHASH; i++) {
b67bfe0d 261 hlist_for_each_entry_safe(file, next, &nlm_files[i], f_list) {
17efa372
WC
262 if (is_failover_file && !is_failover_file(data, file))
263 continue;
01df9c5e
TM
264 file->f_count++;
265 mutex_unlock(&nlm_file_mutex);
266
1da177e4
LT
267 /* Traverse locks, blocks and shares of this file
268 * and update file->f_locks count */
4373ea84 269 if (nlm_inspect_file(data, file, match))
01df9c5e 270 ret = 1;
1da177e4 271
01df9c5e
TM
272 mutex_lock(&nlm_file_mutex);
273 file->f_count--;
1da177e4 274 /* No more references to this file. Let go of it. */
68a2d76c 275 if (list_empty(&file->f_blocks) && !file->f_locks
1da177e4 276 && !file->f_shares && !file->f_count) {
07ba8063 277 hlist_del(&file->f_list);
1da177e4
LT
278 nlmsvc_ops->fclose(file->f_file);
279 kfree(file);
1da177e4
LT
280 }
281 }
282 }
353ab6e9 283 mutex_unlock(&nlm_file_mutex);
01df9c5e 284 return ret;
1da177e4
LT
285}
286
287/*
288 * Release file. If there are no more remote locks on this file,
289 * close it and free the handle.
290 *
291 * Note that we can't do proper reference counting without major
292 * contortions because the code in fs/locks.c creates, deletes and
293 * splits locks without notification. Our only way is to walk the
294 * entire lock list each time we remove a lock.
295 */
296void
297nlm_release_file(struct nlm_file *file)
298{
299 dprintk("lockd: nlm_release_file(%p, ct = %d)\n",
300 file, file->f_count);
301
302 /* Lock file table */
353ab6e9 303 mutex_lock(&nlm_file_mutex);
1da177e4
LT
304
305 /* If there are no more locks etc, delete the file */
f2af793d
OK
306 if (--file->f_count == 0 && !nlm_file_inuse(file))
307 nlm_delete_file(file);
1da177e4 308
353ab6e9 309 mutex_unlock(&nlm_file_mutex);
1da177e4
LT
310}
311
f2af793d
OK
312/*
313 * Helpers function for resource traversal
314 *
315 * nlmsvc_mark_host:
b26411f8
SK
316 * used by the garbage collector; simply sets h_inuse only for those
317 * hosts, which passed network check.
f2af793d
OK
318 * Always returns 0.
319 *
320 * nlmsvc_same_host:
321 * returns 1 iff the two hosts match. Used to release
322 * all resources bound to a specific host.
323 *
324 * nlmsvc_is_client:
325 * returns 1 iff the host is a client.
326 * Used by nlmsvc_invalidate_all
327 */
b26411f8 328
f2af793d 329static int
b26411f8 330nlmsvc_mark_host(void *data, struct nlm_host *hint)
f2af793d 331{
4373ea84
WC
332 struct nlm_host *host = data;
333
b26411f8
SK
334 if ((hint->net == NULL) ||
335 (host->net == hint->net))
336 host->h_inuse = 1;
f2af793d
OK
337 return 0;
338}
339
340static int
4373ea84 341nlmsvc_same_host(void *data, struct nlm_host *other)
f2af793d 342{
4373ea84
WC
343 struct nlm_host *host = data;
344
f2af793d
OK
345 return host == other;
346}
347
348static int
4373ea84 349nlmsvc_is_client(void *data, struct nlm_host *dummy)
f2af793d 350{
4373ea84
WC
351 struct nlm_host *host = data;
352
4481d103
N
353 if (host->h_server) {
354 /* we are destroying locks even though the client
355 * hasn't asked us too, so don't unmonitor the
356 * client
357 */
358 if (host->h_nsmhandle)
359 host->h_nsmhandle->sm_sticky = 1;
360 return 1;
361 } else
362 return 0;
f2af793d
OK
363}
364
1da177e4
LT
365/*
366 * Mark all hosts that still hold resources
367 */
368void
b26411f8 369nlmsvc_mark_resources(struct net *net)
1da177e4 370{
b26411f8
SK
371 struct nlm_host hint;
372
e919b076 373 dprintk("lockd: %s for net %x\n", __func__, net ? net->ns.inum : 0);
b26411f8
SK
374 hint.net = net;
375 nlm_traverse_files(&hint, nlmsvc_mark_host, NULL);
1da177e4
LT
376}
377
378/*
379 * Release all resources held by the given client
380 */
381void
382nlmsvc_free_host_resources(struct nlm_host *host)
383{
384 dprintk("lockd: nlmsvc_free_host_resources\n");
385
17efa372 386 if (nlm_traverse_files(host, nlmsvc_same_host, NULL)) {
1da177e4 387 printk(KERN_WARNING
f0737a39 388 "lockd: couldn't remove all locks held by %s\n",
1da177e4 389 host->h_name);
f0737a39
OK
390 BUG();
391 }
1da177e4
LT
392}
393
367c8c7b
CL
394/**
395 * nlmsvc_invalidate_all - remove all locks held for clients
396 *
397 * Release all locks held by NFS clients.
398 *
1da177e4
LT
399 */
400void
401nlmsvc_invalidate_all(void)
402{
367c8c7b 403 /*
f2af793d
OK
404 * Previously, the code would call
405 * nlmsvc_free_host_resources for each client in
406 * turn, which is about as inefficient as it gets.
407 * Now we just do it once in nlm_traverse_files.
408 */
17efa372
WC
409 nlm_traverse_files(NULL, nlmsvc_is_client, NULL);
410}
411
412static int
413nlmsvc_match_sb(void *datap, struct nlm_file *file)
414{
415 struct super_block *sb = datap;
416
30e46aba 417 return sb == file_inode(file->f_file)->i_sb;
17efa372
WC
418}
419
367c8c7b
CL
420/**
421 * nlmsvc_unlock_all_by_sb - release locks held on this file system
422 * @sb: super block
423 *
424 * Release all locks held by clients accessing this file system.
425 */
17efa372
WC
426int
427nlmsvc_unlock_all_by_sb(struct super_block *sb)
428{
429 int ret;
430
431 ret = nlm_traverse_files(sb, nlmsvc_always_match, nlmsvc_match_sb);
432 return ret ? -EIO : 0;
1da177e4 433}
17efa372 434EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_sb);
4373ea84
WC
435
436static int
437nlmsvc_match_ip(void *datap, struct nlm_host *host)
438{
4516fc04 439 return rpc_cmp_addr(nlm_srcaddr(host), datap);
4373ea84
WC
440}
441
367c8c7b
CL
442/**
443 * nlmsvc_unlock_all_by_ip - release local locks by IP address
444 * @server_addr: server's IP address as seen by clients
445 *
446 * Release all locks held by clients accessing this host
447 * via the passed in IP address.
448 */
4373ea84 449int
367c8c7b 450nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr)
4373ea84
WC
451{
452 int ret;
4373ea84 453
367c8c7b
CL
454 ret = nlm_traverse_files(server_addr, nlmsvc_match_ip, NULL);
455 return ret ? -EIO : 0;
4373ea84
WC
456}
457EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_ip);