fs/lockd/svcsubs.c

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