1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/fs/lockd/svcsubs.c
5 * Various support routines for the NLM server.
7 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
10 #include <linux/types.h>
11 #include <linux/string.h>
12 #include <linux/time.h>
14 #include <linux/slab.h>
15 #include <linux/mutex.h>
16 #include <linux/sunrpc/svc.h>
17 #include <linux/sunrpc/addr.h>
18 #include <linux/lockd/lockd.h>
19 #include <linux/lockd/share.h>
20 #include <linux/module.h>
21 #include <linux/mount.h>
22 #include <uapi/linux/nfs2.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
);
35 #ifdef CONFIG_SUNRPC_DEBUG
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
= locks_inode(file
->f_file
);
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 nlm_file
*file
;
91 nlm_debug_print_fh("nlm_lookup_file", f
);
96 mutex_lock(&nlm_file_mutex
);
98 hlist_for_each_entry(file
, &nlm_files
[hash
], f_list
)
99 if (!nfs_compare_fh(&file
->f_handle
, f
))
102 nlm_debug_print_fh("creating file for", f
);
104 nfserr
= nlm_lck_denied_nolocks
;
105 file
= kzalloc(sizeof(*file
), GFP_KERNEL
);
109 memcpy(&file
->f_handle
, f
, sizeof(struct nfs_fh
));
110 mutex_init(&file
->f_mutex
);
111 INIT_HLIST_NODE(&file
->f_list
);
112 INIT_LIST_HEAD(&file
->f_blocks
);
114 /* Open the file. Note that this must not sleep for too long, else
115 * we would lock up lockd:-) So no NFS re-exports, folks.
117 * We have to make sure we have the right credential to open
120 if ((nfserr
= nlmsvc_ops
->fopen(rqstp
, f
, &file
->f_file
)) != 0) {
121 dprintk("lockd: open failed (error %d)\n", nfserr
);
125 hlist_add_head(&file
->f_list
, &nlm_files
[hash
]);
128 dprintk("lockd: found file %p (count %d)\n", file
, file
->f_count
);
134 mutex_unlock(&nlm_file_mutex
);
143 * Delete a file after having released all locks, blocks and shares
146 nlm_delete_file(struct nlm_file
*file
)
148 nlm_debug_print_file("closing file", file
);
149 if (!hlist_unhashed(&file
->f_list
)) {
150 hlist_del(&file
->f_list
);
151 nlmsvc_ops
->fclose(file
->f_file
);
154 printk(KERN_WARNING
"lockd: attempt to release unknown file!\n");
159 * Loop over all locks on the given file and perform the specified
163 nlm_traverse_locks(struct nlm_host
*host
, struct nlm_file
*file
,
164 nlm_host_match_fn_t match
)
166 struct inode
*inode
= nlmsvc_file_inode(file
);
167 struct file_lock
*fl
;
168 struct file_lock_context
*flctx
= inode
->i_flctx
;
169 struct nlm_host
*lockhost
;
171 if (!flctx
|| list_empty_careful(&flctx
->flc_posix
))
175 spin_lock(&flctx
->flc_lock
);
176 list_for_each_entry(fl
, &flctx
->flc_posix
, fl_list
) {
177 if (fl
->fl_lmops
!= &nlmsvc_lock_operations
)
180 /* update current lock count */
183 lockhost
= (struct nlm_host
*) fl
->fl_owner
;
184 if (match(lockhost
, host
)) {
185 struct file_lock lock
= *fl
;
187 spin_unlock(&flctx
->flc_lock
);
188 lock
.fl_type
= F_UNLCK
;
190 lock
.fl_end
= OFFSET_MAX
;
191 if (vfs_lock_file(file
->f_file
, F_SETLK
, &lock
, NULL
) < 0) {
192 printk("lockd: unlock failure in %s:%d\n",
199 spin_unlock(&flctx
->flc_lock
);
205 nlmsvc_always_match(void *dummy1
, struct nlm_host
*dummy2
)
211 * Inspect a single file
214 nlm_inspect_file(struct nlm_host
*host
, struct nlm_file
*file
, nlm_host_match_fn_t match
)
216 nlmsvc_traverse_blocks(host
, file
, match
);
217 nlmsvc_traverse_shares(host
, file
, match
);
218 return nlm_traverse_locks(host
, file
, match
);
222 * Quick check whether there are still any locks, blocks or
223 * shares on a given file.
226 nlm_file_inuse(struct nlm_file
*file
)
228 struct inode
*inode
= nlmsvc_file_inode(file
);
229 struct file_lock
*fl
;
230 struct file_lock_context
*flctx
= inode
->i_flctx
;
232 if (file
->f_count
|| !list_empty(&file
->f_blocks
) || file
->f_shares
)
235 if (flctx
&& !list_empty_careful(&flctx
->flc_posix
)) {
236 spin_lock(&flctx
->flc_lock
);
237 list_for_each_entry(fl
, &flctx
->flc_posix
, fl_list
) {
238 if (fl
->fl_lmops
== &nlmsvc_lock_operations
) {
239 spin_unlock(&flctx
->flc_lock
);
243 spin_unlock(&flctx
->flc_lock
);
250 * Loop over all files in the file table.
253 nlm_traverse_files(void *data
, nlm_host_match_fn_t match
,
254 int (*is_failover_file
)(void *data
, struct nlm_file
*file
))
256 struct hlist_node
*next
;
257 struct nlm_file
*file
;
260 mutex_lock(&nlm_file_mutex
);
261 for (i
= 0; i
< FILE_NRHASH
; i
++) {
262 hlist_for_each_entry_safe(file
, next
, &nlm_files
[i
], f_list
) {
263 if (is_failover_file
&& !is_failover_file(data
, file
))
266 mutex_unlock(&nlm_file_mutex
);
268 /* Traverse locks, blocks and shares of this file
269 * and update file->f_locks count */
270 if (nlm_inspect_file(data
, file
, match
))
273 mutex_lock(&nlm_file_mutex
);
275 /* No more references to this file. Let go of it. */
276 if (list_empty(&file
->f_blocks
) && !file
->f_locks
277 && !file
->f_shares
&& !file
->f_count
) {
278 hlist_del(&file
->f_list
);
279 nlmsvc_ops
->fclose(file
->f_file
);
284 mutex_unlock(&nlm_file_mutex
);
289 * Release file. If there are no more remote locks on this file,
290 * close it and free the handle.
292 * Note that we can't do proper reference counting without major
293 * contortions because the code in fs/locks.c creates, deletes and
294 * splits locks without notification. Our only way is to walk the
295 * entire lock list each time we remove a lock.
298 nlm_release_file(struct nlm_file
*file
)
300 dprintk("lockd: nlm_release_file(%p, ct = %d)\n",
301 file
, file
->f_count
);
303 /* Lock file table */
304 mutex_lock(&nlm_file_mutex
);
306 /* If there are no more locks etc, delete the file */
307 if (--file
->f_count
== 0 && !nlm_file_inuse(file
))
308 nlm_delete_file(file
);
310 mutex_unlock(&nlm_file_mutex
);
314 * Helpers function for resource traversal
317 * used by the garbage collector; simply sets h_inuse only for those
318 * hosts, which passed network check.
322 * returns 1 iff the two hosts match. Used to release
323 * all resources bound to a specific host.
326 * returns 1 iff the host is a client.
327 * Used by nlmsvc_invalidate_all
331 nlmsvc_mark_host(void *data
, struct nlm_host
*hint
)
333 struct nlm_host
*host
= data
;
335 if ((hint
->net
== NULL
) ||
336 (host
->net
== hint
->net
))
342 nlmsvc_same_host(void *data
, struct nlm_host
*other
)
344 struct nlm_host
*host
= data
;
346 return host
== other
;
350 nlmsvc_is_client(void *data
, struct nlm_host
*dummy
)
352 struct nlm_host
*host
= data
;
354 if (host
->h_server
) {
355 /* we are destroying locks even though the client
356 * hasn't asked us too, so don't unmonitor the
359 if (host
->h_nsmhandle
)
360 host
->h_nsmhandle
->sm_sticky
= 1;
367 * Mark all hosts that still hold resources
370 nlmsvc_mark_resources(struct net
*net
)
372 struct nlm_host hint
;
374 dprintk("lockd: %s for net %x\n", __func__
, net
? net
->ns
.inum
: 0);
376 nlm_traverse_files(&hint
, nlmsvc_mark_host
, NULL
);
380 * Release all resources held by the given client
383 nlmsvc_free_host_resources(struct nlm_host
*host
)
385 dprintk("lockd: nlmsvc_free_host_resources\n");
387 if (nlm_traverse_files(host
, nlmsvc_same_host
, NULL
)) {
389 "lockd: couldn't remove all locks held by %s\n",
396 * nlmsvc_invalidate_all - remove all locks held for clients
398 * Release all locks held by NFS clients.
402 nlmsvc_invalidate_all(void)
405 * Previously, the code would call
406 * nlmsvc_free_host_resources for each client in
407 * turn, which is about as inefficient as it gets.
408 * Now we just do it once in nlm_traverse_files.
410 nlm_traverse_files(NULL
, nlmsvc_is_client
, NULL
);
414 nlmsvc_match_sb(void *datap
, struct nlm_file
*file
)
416 struct super_block
*sb
= datap
;
418 return sb
== locks_inode(file
->f_file
)->i_sb
;
422 * nlmsvc_unlock_all_by_sb - release locks held on this file system
425 * Release all locks held by clients accessing this file system.
428 nlmsvc_unlock_all_by_sb(struct super_block
*sb
)
432 ret
= nlm_traverse_files(sb
, nlmsvc_always_match
, nlmsvc_match_sb
);
433 return ret
? -EIO
: 0;
435 EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_sb
);
438 nlmsvc_match_ip(void *datap
, struct nlm_host
*host
)
440 return rpc_cmp_addr(nlm_srcaddr(host
), datap
);
444 * nlmsvc_unlock_all_by_ip - release local locks by IP address
445 * @server_addr: server's IP address as seen by clients
447 * Release all locks held by clients accessing this host
448 * via the passed in IP address.
451 nlmsvc_unlock_all_by_ip(struct sockaddr
*server_addr
)
455 ret
= nlm_traverse_files(server_addr
, nlmsvc_match_ip
, NULL
);
456 return ret
? -EIO
: 0;
458 EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_ip
);