fs/lockd/svcsubs.c

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