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/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>
  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 NFSD_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 = file->f_file->f_path.dentry->d_inode;
  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 nfs_fh *f)
  86 {
  87         struct hlist_node *pos;
  88         struct nlm_file *file;
  89         unsigned int    hash;
  90         __be32          nfserr;
  91
  92         nlm_debug_print_fh("nlm_lookup_file", f);
  93
  94         hash = file_hash(f);
  95
  96         /* Lock file table */
  97         mutex_lock(&nlm_file_mutex);
  98
  99         hlist_for_each_entry(file, pos, &nlm_files[hash], f_list)
 100                 if (!nfs_compare_fh(&file->f_handle, f))
 101                         goto found;
 102
 103         nlm_debug_print_fh("creating file for", f);
 104
 105         nfserr = nlm_lck_denied_nolocks;
 106         file = kzalloc(sizeof(*file), GFP_KERNEL);
 107         if (!file)
 108                 goto out_unlock;
 109
 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);
 114
 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.
 117          *
 118          * We have to make sure we have the right credential to open
 119          * the file.
 120          */
 121         if ((nfserr = nlmsvc_ops->fopen(rqstp, f, &file->f_file)) != 0) {
 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 nlm_host  *lockhost;
 170
 171 again:
 172         file->f_locks = 0;
 173         for (fl = inode->i_flock; fl; fl = fl->fl_next) {
 174                 if (fl->fl_lmops != &nlmsvc_lock_operations)
 175                         continue;
 176
 177                 /* update current lock count */
 178                 file->f_locks++;
 179
 180                 lockhost = (struct nlm_host *) fl->fl_owner;
 181                 if (match(lockhost, host)) {
 182                         struct file_lock lock = *fl;
 183
 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
 196         return 0;
 197 }
 198
 199 static int
 200 nlmsvc_always_match(void *dummy1, struct nlm_host *dummy2)
 201 {
 202         return 1;
 203 }
 204
 205 /*
 206  * Inspect a single file
 207  */
 208 static inline int
 209 nlm_inspect_file(struct nlm_host *host, struct nlm_file *file, nlm_host_match_fn_t match)
 210 {
 211         nlmsvc_traverse_blocks(host, file, match);
 212         nlmsvc_traverse_shares(host, file, match);
 213         return nlm_traverse_locks(host, file, match);
 214 }
 215
 216 /*
 217  * Quick check whether there are still any locks, blocks or
 218  * shares on a given file.
 219  */
 220 static inline int
 221 nlm_file_inuse(struct nlm_file *file)
 222 {
 223         struct inode     *inode = nlmsvc_file_inode(file);
 224         struct file_lock *fl;
 225
 226         if (file->f_count || !list_empty(&file->f_blocks) || file->f_shares)
 227                 return 1;
 228
 229         for (fl = inode->i_flock; fl; fl = fl->fl_next) {
 230                 if (fl->fl_lmops == &nlmsvc_lock_operations)
 231                         return 1;
 232         }
 233         file->f_locks = 0;
 234         return 0;
 235 }
 236
 237 /*
 238  * Loop over all files in the file table.
 239  */
 240 static int
 241 nlm_traverse_files(void *data, nlm_host_match_fn_t match,
 242                 int (*is_failover_file)(void *data, struct nlm_file *file))
 243 {
 244         struct hlist_node *pos, *next;
 245         struct nlm_file *file;
 246         int i, ret = 0;
 247
 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))
 252                                 continue;
 253                         file->f_count++;
 254                         mutex_unlock(&nlm_file_mutex);
 255
 256                         /* Traverse locks, blocks and shares of this file
 257                          * and update file->f_locks count */
 258                         if (nlm_inspect_file(data, file, match))
 259                                 ret = 1;
 260
 261                         mutex_lock(&nlm_file_mutex);
 262                         file->f_count--;
 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);
 268                                 kfree(file);
 269                         }
 270                 }
 271         }
 272         mutex_unlock(&nlm_file_mutex);
 273         return ret;
 274 }
 275
 276 /*
 277  * Release file. If there are no more remote locks on this file,
 278  * close it and free the handle.
 279  *
 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.
 284  */
 285 void
 286 nlm_release_file(struct nlm_file *file)
 287 {
 288         dprintk("lockd: nlm_release_file(%p, ct = %d)\n",
 289                                 file, file->f_count);
 290
 291         /* Lock file table */
 292         mutex_lock(&nlm_file_mutex);
 293
 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);
 297
 298         mutex_unlock(&nlm_file_mutex);
 299 }
 300
 301 /*
 302  * Helpers function for resource traversal
 303  *
 304  * nlmsvc_mark_host:
 305  *      used by the garbage collector; simply sets h_inuse.
 306  *      Always returns 0.
 307  *
 308  * nlmsvc_same_host:
 309  *      returns 1 iff the two hosts match. Used to release
 310  *      all resources bound to a specific host.
 311  *
 312  * nlmsvc_is_client:
 313  *      returns 1 iff the host is a client.
 314  *      Used by nlmsvc_invalidate_all
 315  */
 316 static int
 317 nlmsvc_mark_host(void *data, struct nlm_host *dummy)
 318 {
 319         struct nlm_host *host = data;
 320
 321         host->h_inuse = 1;
 322         return 0;
 323 }
 324
 325 static int
 326 nlmsvc_same_host(void *data, struct nlm_host *other)
 327 {
 328         struct nlm_host *host = data;
 329
 330         return host == other;
 331 }
 332
 333 static int
 334 nlmsvc_is_client(void *data, struct nlm_host *dummy)
 335 {
 336         struct nlm_host *host = data;
 337
 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
 341                  * client
 342                  */
 343                 if (host->h_nsmhandle)
 344                         host->h_nsmhandle->sm_sticky = 1;
 345                 return 1;
 346         } else
 347                 return 0;
 348 }
 349
 350 /*
 351  * Mark all hosts that still hold resources
 352  */
 353 void
 354 nlmsvc_mark_resources(void)
 355 {
 356         dprintk("lockd: nlmsvc_mark_resources\n");
 357         nlm_traverse_files(NULL, nlmsvc_mark_host, NULL);
 358 }
 359
 360 /*
 361  * Release all resources held by the given client
 362  */
 363 void
 364 nlmsvc_free_host_resources(struct nlm_host *host)
 365 {
 366         dprintk("lockd: nlmsvc_free_host_resources\n");
 367
 368         if (nlm_traverse_files(host, nlmsvc_same_host, NULL)) {
 369                 printk(KERN_WARNING
 370                         "lockd: couldn't remove all locks held by %s\n",
 371                         host->h_name);
 372                 BUG();
 373         }
 374 }
 375
 376 /**
 377  * nlmsvc_invalidate_all - remove all locks held for clients
 378  *
 379  * Release all locks held by NFS clients.
 380  *
 381  */
 382 void
 383 nlmsvc_invalidate_all(void)
 384 {
 385         /*
 386          * Previously, the code would call
 387          * nlmsvc_free_host_resources for each client in
 388          * turn, which is about as inefficient as it gets.
 389          * Now we just do it once in nlm_traverse_files.
 390          */
 391         nlm_traverse_files(NULL, nlmsvc_is_client, NULL);
 392 }
 393
 394 static int
 395 nlmsvc_match_sb(void *datap, struct nlm_file *file)
 396 {
 397         struct super_block *sb = datap;
 398
 399         return sb == file->f_file->f_path.mnt->mnt_sb;
 400 }
 401
 402 /**
 403  * nlmsvc_unlock_all_by_sb - release locks held on this file system
 404  * @sb: super block
 405  *
 406  * Release all locks held by clients accessing this file system.
 407  */
 408 int
 409 nlmsvc_unlock_all_by_sb(struct super_block *sb)
 410 {
 411         int ret;
 412
 413         ret = nlm_traverse_files(sb, nlmsvc_always_match, nlmsvc_match_sb);
 414         return ret ? -EIO : 0;
 415 }
 416 EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_sb);
 417
 418 static int
 419 nlmsvc_match_ip(void *datap, struct nlm_host *host)
 420 {
 421         return nlm_cmp_addr(&host->h_saddr, datap);
 422 }
 423
 424 /**
 425  * nlmsvc_unlock_all_by_ip - release local locks by IP address
 426  * @server_addr: server's IP address as seen by clients
 427  *
 428  * Release all locks held by clients accessing this host
 429  * via the passed in IP address.
 430  */
 431 int
 432 nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr)
 433 {
 434         int ret;
 435
 436         ret = nlm_traverse_files(server_addr, nlmsvc_match_ip, NULL);
 437         return ret ? -EIO : 0;
 438 }
 439 EXPORT_SYMBOL_GPL(nlmsvc_unlock_all_by_ip);