fs/lockd/svclock.c

   1 /*
   2  * linux/fs/lockd/svclock.c
   3  *
   4  * Handling of server-side locks, mostly of the blocked variety.
   5  * This is the ugliest part of lockd because we tread on very thin ice.
   6  * GRANT and CANCEL calls may get stuck, meet in mid-flight, etc.
   7  * IMNSHO introducing the grant callback into the NLM protocol was one
   8  * of the worst ideas Sun ever had. Except maybe for the idea of doing
   9  * NFS file locking at all.
  10  *
  11  * I'm trying hard to avoid race conditions by protecting most accesses
  12  * to a file's list of blocked locks through a semaphore. The global
  13  * list of blocked locks is not protected in this fashion however.
  14  * Therefore, some functions (such as the RPC callback for the async grant
  15  * call) move blocked locks towards the head of the list *while some other
  16  * process might be traversing it*. This should not be a problem in
  17  * practice, because this will only cause functions traversing the list
  18  * to visit some blocks twice.
  19  *
  20  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
  21  */
  22
  23 #include <linux/types.h>
  24 #include <linux/errno.h>
  25 #include <linux/kernel.h>
  26 #include <linux/sched.h>
  27 #include <linux/smp_lock.h>
  28 #include <linux/sunrpc/clnt.h>
  29 #include <linux/sunrpc/svc.h>
  30 #include <linux/lockd/nlm.h>
  31 #include <linux/lockd/lockd.h>
  32 #include <linux/kthread.h>
  33
  34 #define NLMDBG_FACILITY         NLMDBG_SVCLOCK
  35
  36 #ifdef CONFIG_LOCKD_V4
  37 #define nlm_deadlock    nlm4_deadlock
  38 #else
  39 #define nlm_deadlock    nlm_lck_denied
  40 #endif
  41
  42 static void nlmsvc_release_block(struct nlm_block *block);
  43 static void     nlmsvc_insert_block(struct nlm_block *block, unsigned long);
  44 static void     nlmsvc_remove_block(struct nlm_block *block);
  45
  46 static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock);
  47 static void nlmsvc_freegrantargs(struct nlm_rqst *call);
  48 static const struct rpc_call_ops nlmsvc_grant_ops;
  49
  50 /*
  51  * The list of blocked locks to retry
  52  */
  53 static LIST_HEAD(nlm_blocked);
  54
  55 /*
  56  * Insert a blocked lock into the global list
  57  */
  58 static void
  59 nlmsvc_insert_block(struct nlm_block *block, unsigned long when)
  60 {
  61         struct nlm_block *b;
  62         struct list_head *pos;
  63
  64         dprintk("lockd: nlmsvc_insert_block(%p, %ld)\n", block, when);
  65         if (list_empty(&block->b_list)) {
  66                 kref_get(&block->b_count);
  67         } else {
  68                 list_del_init(&block->b_list);
  69         }
  70
  71         pos = &nlm_blocked;
  72         if (when != NLM_NEVER) {
  73                 if ((when += jiffies) == NLM_NEVER)
  74                         when ++;
  75                 list_for_each(pos, &nlm_blocked) {
  76                         b = list_entry(pos, struct nlm_block, b_list);
  77                         if (time_after(b->b_when,when) || b->b_when == NLM_NEVER)
  78                                 break;
  79                 }
  80                 /* On normal exit from the loop, pos == &nlm_blocked,
  81                  * so we will be adding to the end of the list - good
  82                  */
  83         }
  84
  85         list_add_tail(&block->b_list, pos);
  86         block->b_when = when;
  87 }
  88
  89 /*
  90  * Remove a block from the global list
  91  */
  92 static inline void
  93 nlmsvc_remove_block(struct nlm_block *block)
  94 {
  95         if (!list_empty(&block->b_list)) {
  96                 list_del_init(&block->b_list);
  97                 nlmsvc_release_block(block);
  98         }
  99 }
 100
 101 /*
 102  * Find a block for a given lock
 103  */
 104 static struct nlm_block *
 105 nlmsvc_lookup_block(struct nlm_file *file, struct nlm_lock *lock)
 106 {
 107         struct nlm_block        *block;
 108         struct file_lock        *fl;
 109
 110         dprintk("lockd: nlmsvc_lookup_block f=%p pd=%d %Ld-%Ld ty=%d\n",
 111                                 file, lock->fl.fl_pid,
 112                                 (long long)lock->fl.fl_start,
 113                                 (long long)lock->fl.fl_end, lock->fl.fl_type);
 114         list_for_each_entry(block, &nlm_blocked, b_list) {
 115                 fl = &block->b_call->a_args.lock.fl;
 116                 dprintk("lockd: check f=%p pd=%d %Ld-%Ld ty=%d cookie=%s\n",
 117                                 block->b_file, fl->fl_pid,
 118                                 (long long)fl->fl_start,
 119                                 (long long)fl->fl_end, fl->fl_type,
 120                                 nlmdbg_cookie2a(&block->b_call->a_args.cookie));
 121                 if (block->b_file == file && nlm_compare_locks(fl, &lock->fl)) {
 122                         kref_get(&block->b_count);
 123                         return block;
 124                 }
 125         }
 126
 127         return NULL;
 128 }
 129
 130 static inline int nlm_cookie_match(struct nlm_cookie *a, struct nlm_cookie *b)
 131 {
 132         if (a->len != b->len)
 133                 return 0;
 134         if (memcmp(a->data, b->data, a->len))
 135                 return 0;
 136         return 1;
 137 }
 138
 139 /*
 140  * Find a block with a given NLM cookie.
 141  */
 142 static inline struct nlm_block *
 143 nlmsvc_find_block(struct nlm_cookie *cookie)
 144 {
 145         struct nlm_block *block;
 146
 147         list_for_each_entry(block, &nlm_blocked, b_list) {
 148                 if (nlm_cookie_match(&block->b_call->a_args.cookie,cookie))
 149                         goto found;
 150         }
 151
 152         return NULL;
 153
 154 found:
 155         dprintk("nlmsvc_find_block(%s): block=%p\n", nlmdbg_cookie2a(cookie), block);
 156         kref_get(&block->b_count);
 157         return block;
 158 }
 159
 160 /*
 161  * Create a block and initialize it.
 162  *
 163  * Note: we explicitly set the cookie of the grant reply to that of
 164  * the blocked lock request. The spec explicitly mentions that the client
 165  * should _not_ rely on the callback containing the same cookie as the
 166  * request, but (as I found out later) that's because some implementations
 167  * do just this. Never mind the standards comittees, they support our
 168  * logging industries.
 169  *
 170  * 10 years later: I hope we can safely ignore these old and broken
 171  * clients by now. Let's fix this so we can uniquely identify an incoming
 172  * GRANTED_RES message by cookie, without having to rely on the client's IP
 173  * address. --okir
 174  */
 175 static struct nlm_block *
 176 nlmsvc_create_block(struct svc_rqst *rqstp, struct nlm_host *host,
 177                     struct nlm_file *file, struct nlm_lock *lock,
 178                     struct nlm_cookie *cookie)
 179 {
 180         struct nlm_block        *block;
 181         struct nlm_rqst         *call = NULL;
 182
 183         nlm_get_host(host);
 184         call = nlm_alloc_call(host);
 185         if (call == NULL)
 186                 return NULL;
 187
 188         /* Allocate memory for block, and initialize arguments */
 189         block = kzalloc(sizeof(*block), GFP_KERNEL);
 190         if (block == NULL)
 191                 goto failed;
 192         kref_init(&block->b_count);
 193         INIT_LIST_HEAD(&block->b_list);
 194         INIT_LIST_HEAD(&block->b_flist);
 195
 196         if (!nlmsvc_setgrantargs(call, lock))
 197                 goto failed_free;
 198
 199         /* Set notifier function for VFS, and init args */
 200         call->a_args.lock.fl.fl_flags |= FL_SLEEP;
 201         call->a_args.lock.fl.fl_lmops = &nlmsvc_lock_operations;
 202         nlmclnt_next_cookie(&call->a_args.cookie);
 203
 204         dprintk("lockd: created block %p...\n", block);
 205
 206         /* Create and initialize the block */
 207         block->b_daemon = rqstp->rq_server;
 208         block->b_host   = host;
 209         block->b_file   = file;
 210         block->b_fl = NULL;
 211         file->f_count++;
 212
 213         /* Add to file's list of blocks */
 214         list_add(&block->b_flist, &file->f_blocks);
 215
 216         /* Set up RPC arguments for callback */
 217         block->b_call = call;
 218         call->a_flags   = RPC_TASK_ASYNC;
 219         call->a_block = block;
 220
 221         return block;
 222
 223 failed_free:
 224         kfree(block);
 225 failed:
 226         nlm_release_call(call);
 227         return NULL;
 228 }
 229
 230 /*
 231  * Delete a block.
 232  * It is the caller's responsibility to check whether the file
 233  * can be closed hereafter.
 234  */
 235 static int nlmsvc_unlink_block(struct nlm_block *block)
 236 {
 237         int status;
 238         dprintk("lockd: unlinking block %p...\n", block);
 239
 240         /* Remove block from list */
 241         status = posix_unblock_lock(block->b_file->f_file, &block->b_call->a_args.lock.fl);
 242         nlmsvc_remove_block(block);
 243         return status;
 244 }
 245
 246 static void nlmsvc_free_block(struct kref *kref)
 247 {
 248         struct nlm_block *block = container_of(kref, struct nlm_block, b_count);
 249         struct nlm_file         *file = block->b_file;
 250
 251         dprintk("lockd: freeing block %p...\n", block);
 252
 253         /* Remove block from file's list of blocks */
 254         mutex_lock(&file->f_mutex);
 255         list_del_init(&block->b_flist);
 256         mutex_unlock(&file->f_mutex);
 257
 258         nlmsvc_freegrantargs(block->b_call);
 259         nlm_release_call(block->b_call);
 260         nlm_release_file(block->b_file);
 261         kfree(block->b_fl);
 262         kfree(block);
 263 }
 264
 265 static void nlmsvc_release_block(struct nlm_block *block)
 266 {
 267         if (block != NULL)
 268                 kref_put(&block->b_count, nlmsvc_free_block);
 269 }
 270
 271 /*
 272  * Loop over all blocks and delete blocks held by
 273  * a matching host.
 274  */
 275 void nlmsvc_traverse_blocks(struct nlm_host *host,
 276                         struct nlm_file *file,
 277                         nlm_host_match_fn_t match)
 278 {
 279         struct nlm_block *block, *next;
 280
 281 restart:
 282         mutex_lock(&file->f_mutex);
 283         list_for_each_entry_safe(block, next, &file->f_blocks, b_flist) {
 284                 if (!match(block->b_host, host))
 285                         continue;
 286                 /* Do not destroy blocks that are not on
 287                  * the global retry list - why? */
 288                 if (list_empty(&block->b_list))
 289                         continue;
 290                 kref_get(&block->b_count);
 291                 mutex_unlock(&file->f_mutex);
 292                 nlmsvc_unlink_block(block);
 293                 nlmsvc_release_block(block);
 294                 goto restart;
 295         }
 296         mutex_unlock(&file->f_mutex);
 297 }
 298
 299 /*
 300  * Initialize arguments for GRANTED call. The nlm_rqst structure
 301  * has been cleared already.
 302  */
 303 static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock)
 304 {
 305         locks_copy_lock(&call->a_args.lock.fl, &lock->fl);
 306         memcpy(&call->a_args.lock.fh, &lock->fh, sizeof(call->a_args.lock.fh));
 307         call->a_args.lock.caller = utsname()->nodename;
 308         call->a_args.lock.oh.len = lock->oh.len;
 309
 310         /* set default data area */
 311         call->a_args.lock.oh.data = call->a_owner;
 312         call->a_args.lock.svid = lock->fl.fl_pid;
 313
 314         if (lock->oh.len > NLMCLNT_OHSIZE) {
 315                 void *data = kmalloc(lock->oh.len, GFP_KERNEL);
 316                 if (!data)
 317                         return 0;
 318                 call->a_args.lock.oh.data = (u8 *) data;
 319         }
 320
 321         memcpy(call->a_args.lock.oh.data, lock->oh.data, lock->oh.len);
 322         return 1;
 323 }
 324
 325 static void nlmsvc_freegrantargs(struct nlm_rqst *call)
 326 {
 327         if (call->a_args.lock.oh.data != call->a_owner)
 328                 kfree(call->a_args.lock.oh.data);
 329 }
 330
 331 /*
 332  * Deferred lock request handling for non-blocking lock
 333  */
 334 static __be32
 335 nlmsvc_defer_lock_rqst(struct svc_rqst *rqstp, struct nlm_block *block)
 336 {
 337         __be32 status = nlm_lck_denied_nolocks;
 338
 339         block->b_flags |= B_QUEUED;
 340
 341         nlmsvc_insert_block(block, NLM_TIMEOUT);
 342
 343         block->b_cache_req = &rqstp->rq_chandle;
 344         if (rqstp->rq_chandle.defer) {
 345                 block->b_deferred_req =
 346                         rqstp->rq_chandle.defer(block->b_cache_req);
 347                 if (block->b_deferred_req != NULL)
 348                         status = nlm_drop_reply;
 349         }
 350         dprintk("lockd: nlmsvc_defer_lock_rqst block %p flags %d status %d\n",
 351                 block, block->b_flags, ntohl(status));
 352
 353         return status;
 354 }
 355
 356 /*
 357  * Attempt to establish a lock, and if it can't be granted, block it
 358  * if required.
 359  */
 360 __be32
 361 nlmsvc_lock(struct svc_rqst *rqstp, struct nlm_file *file,
 362             struct nlm_host *host, struct nlm_lock *lock, int wait,
 363             struct nlm_cookie *cookie, int reclaim)
 364 {
 365         struct nlm_block        *block = NULL;
 366         int                     error;
 367         __be32                  ret;
 368
 369         dprintk("lockd: nlmsvc_lock(%s/%ld, ty=%d, pi=%d, %Ld-%Ld, bl=%d)\n",
 370                                 file->f_file->f_path.dentry->d_inode->i_sb->s_id,
 371                                 file->f_file->f_path.dentry->d_inode->i_ino,
 372                                 lock->fl.fl_type, lock->fl.fl_pid,
 373                                 (long long)lock->fl.fl_start,
 374                                 (long long)lock->fl.fl_end,
 375                                 wait);
 376
 377         /* Lock file against concurrent access */
 378         mutex_lock(&file->f_mutex);
 379         /* Get existing block (in case client is busy-waiting)
 380          * or create new block
 381          */
 382         block = nlmsvc_lookup_block(file, lock);
 383         if (block == NULL) {
 384                 block = nlmsvc_create_block(rqstp, host, file, lock, cookie);
 385                 ret = nlm_lck_denied_nolocks;
 386                 if (block == NULL)
 387                         goto out;
 388                 lock = &block->b_call->a_args.lock;
 389         } else
 390                 lock->fl.fl_flags &= ~FL_SLEEP;
 391
 392         if (block->b_flags & B_QUEUED) {
 393                 dprintk("lockd: nlmsvc_lock deferred block %p flags %d\n",
 394                                                         block, block->b_flags);
 395                 if (block->b_granted) {
 396                         nlmsvc_unlink_block(block);
 397                         ret = nlm_granted;
 398                         goto out;
 399                 }
 400                 if (block->b_flags & B_TIMED_OUT) {
 401                         nlmsvc_unlink_block(block);
 402                         ret = nlm_lck_denied;
 403                         goto out;
 404                 }
 405                 ret = nlm_drop_reply;
 406                 goto out;
 407         }
 408
 409         if (locks_in_grace() && !reclaim) {
 410                 ret = nlm_lck_denied_grace_period;
 411                 goto out;
 412         }
 413
 414         if (!wait)
 415                 lock->fl.fl_flags &= ~FL_SLEEP;
 416         error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
 417         lock->fl.fl_flags &= ~FL_SLEEP;
 418
 419         dprintk("lockd: vfs_lock_file returned %d\n", error);
 420         switch (error) {
 421                 case 0:
 422                         ret = nlm_granted;
 423                         goto out;
 424                 case -EAGAIN:
 425                         ret = nlm_lck_denied;
 426                         goto out;
 427                 case FILE_LOCK_DEFERRED:
 428                         if (wait)
 429                                 break;
 430                         /* Filesystem lock operation is in progress
 431                            Add it to the queue waiting for callback */
 432                         ret = nlmsvc_defer_lock_rqst(rqstp, block);
 433                         goto out;
 434                 case -EDEADLK:
 435                         ret = nlm_deadlock;
 436                         goto out;
 437                 default:                        /* includes ENOLCK */
 438                         ret = nlm_lck_denied_nolocks;
 439                         goto out;
 440         }
 441
 442         ret = nlm_lck_blocked;
 443
 444         /* Append to list of blocked */
 445         nlmsvc_insert_block(block, NLM_NEVER);
 446 out:
 447         mutex_unlock(&file->f_mutex);
 448         nlmsvc_release_block(block);
 449         dprintk("lockd: nlmsvc_lock returned %u\n", ret);
 450         return ret;
 451 }
 452
 453 /*
 454  * Test for presence of a conflicting lock.
 455  */
 456 __be32
 457 nlmsvc_testlock(struct svc_rqst *rqstp, struct nlm_file *file,
 458                 struct nlm_host *host, struct nlm_lock *lock,
 459                 struct nlm_lock *conflock, struct nlm_cookie *cookie)
 460 {
 461         struct nlm_block        *block = NULL;
 462         int                     error;
 463         __be32                  ret;
 464
 465         dprintk("lockd: nlmsvc_testlock(%s/%ld, ty=%d, %Ld-%Ld)\n",
 466                                 file->f_file->f_path.dentry->d_inode->i_sb->s_id,
 467                                 file->f_file->f_path.dentry->d_inode->i_ino,
 468                                 lock->fl.fl_type,
 469                                 (long long)lock->fl.fl_start,
 470                                 (long long)lock->fl.fl_end);
 471
 472         /* Get existing block (in case client is busy-waiting) */
 473         block = nlmsvc_lookup_block(file, lock);
 474
 475         if (block == NULL) {
 476                 struct file_lock *conf = kzalloc(sizeof(*conf), GFP_KERNEL);
 477
 478                 if (conf == NULL)
 479                         return nlm_granted;
 480                 block = nlmsvc_create_block(rqstp, host, file, lock, cookie);
 481                 if (block == NULL) {
 482                         kfree(conf);
 483                         return nlm_granted;
 484                 }
 485                 block->b_fl = conf;
 486         }
 487         if (block->b_flags & B_QUEUED) {
 488                 dprintk("lockd: nlmsvc_testlock deferred block %p flags %d fl %p\n",
 489                         block, block->b_flags, block->b_fl);
 490                 if (block->b_flags & B_TIMED_OUT) {
 491                         nlmsvc_unlink_block(block);
 492                         ret = nlm_lck_denied;
 493                         goto out;
 494                 }
 495                 if (block->b_flags & B_GOT_CALLBACK) {
 496                         nlmsvc_unlink_block(block);
 497                         if (block->b_fl != NULL
 498                                         && block->b_fl->fl_type != F_UNLCK) {
 499                                 lock->fl = *block->b_fl;
 500                                 goto conf_lock;
 501                         } else {
 502                                 ret = nlm_granted;
 503                                 goto out;
 504                         }
 505                 }
 506                 ret = nlm_drop_reply;
 507                 goto out;
 508         }
 509
 510         if (locks_in_grace()) {
 511                 ret = nlm_lck_denied_grace_period;
 512                 goto out;
 513         }
 514         error = vfs_test_lock(file->f_file, &lock->fl);
 515         if (error == FILE_LOCK_DEFERRED) {
 516                 ret = nlmsvc_defer_lock_rqst(rqstp, block);
 517                 goto out;
 518         }
 519         if (error) {
 520                 ret = nlm_lck_denied_nolocks;
 521                 goto out;
 522         }
 523         if (lock->fl.fl_type == F_UNLCK) {
 524                 ret = nlm_granted;
 525                 goto out;
 526         }
 527
 528 conf_lock:
 529         dprintk("lockd: conflicting lock(ty=%d, %Ld-%Ld)\n",
 530                 lock->fl.fl_type, (long long)lock->fl.fl_start,
 531                 (long long)lock->fl.fl_end);
 532         conflock->caller = "somehost";  /* FIXME */
 533         conflock->len = strlen(conflock->caller);
 534         conflock->oh.len = 0;           /* don't return OH info */
 535         conflock->svid = lock->fl.fl_pid;
 536         conflock->fl.fl_type = lock->fl.fl_type;
 537         conflock->fl.fl_start = lock->fl.fl_start;
 538         conflock->fl.fl_end = lock->fl.fl_end;
 539         ret = nlm_lck_denied;
 540 out:
 541         if (block)
 542                 nlmsvc_release_block(block);
 543         return ret;
 544 }
 545
 546 /*
 547  * Remove a lock.
 548  * This implies a CANCEL call: We send a GRANT_MSG, the client replies
 549  * with a GRANT_RES call which gets lost, and calls UNLOCK immediately
 550  * afterwards. In this case the block will still be there, and hence
 551  * must be removed.
 552  */
 553 __be32
 554 nlmsvc_unlock(struct nlm_file *file, struct nlm_lock *lock)
 555 {
 556         int     error;
 557
 558         dprintk("lockd: nlmsvc_unlock(%s/%ld, pi=%d, %Ld-%Ld)\n",
 559                                 file->f_file->f_path.dentry->d_inode->i_sb->s_id,
 560                                 file->f_file->f_path.dentry->d_inode->i_ino,
 561                                 lock->fl.fl_pid,
 562                                 (long long)lock->fl.fl_start,
 563                                 (long long)lock->fl.fl_end);
 564
 565         /* First, cancel any lock that might be there */
 566         nlmsvc_cancel_blocked(file, lock);
 567
 568         lock->fl.fl_type = F_UNLCK;
 569         error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
 570
 571         return (error < 0)? nlm_lck_denied_nolocks : nlm_granted;
 572 }
 573
 574 /*
 575  * Cancel a previously blocked request.
 576  *
 577  * A cancel request always overrides any grant that may currently
 578  * be in progress.
 579  * The calling procedure must check whether the file can be closed.
 580  */
 581 __be32
 582 nlmsvc_cancel_blocked(struct nlm_file *file, struct nlm_lock *lock)
 583 {
 584         struct nlm_block        *block;
 585         int status = 0;
 586
 587         dprintk("lockd: nlmsvc_cancel(%s/%ld, pi=%d, %Ld-%Ld)\n",
 588                                 file->f_file->f_path.dentry->d_inode->i_sb->s_id,
 589                                 file->f_file->f_path.dentry->d_inode->i_ino,
 590                                 lock->fl.fl_pid,
 591                                 (long long)lock->fl.fl_start,
 592                                 (long long)lock->fl.fl_end);
 593
 594         if (locks_in_grace())
 595                 return nlm_lck_denied_grace_period;
 596
 597         mutex_lock(&file->f_mutex);
 598         block = nlmsvc_lookup_block(file, lock);
 599         mutex_unlock(&file->f_mutex);
 600         if (block != NULL) {
 601                 vfs_cancel_lock(block->b_file->f_file,
 602                                 &block->b_call->a_args.lock.fl);
 603                 status = nlmsvc_unlink_block(block);
 604                 nlmsvc_release_block(block);
 605         }
 606         return status ? nlm_lck_denied : nlm_granted;
 607 }
 608
 609 /*
 610  * This is a callback from the filesystem for VFS file lock requests.
 611  * It will be used if fl_grant is defined and the filesystem can not
 612  * respond to the request immediately.
 613  * For GETLK request it will copy the reply to the nlm_block.
 614  * For SETLK or SETLKW request it will get the local posix lock.
 615  * In all cases it will move the block to the head of nlm_blocked q where
 616  * nlmsvc_retry_blocked() can send back a reply for SETLKW or revisit the
 617  * deferred rpc for GETLK and SETLK.
 618  */
 619 static void
 620 nlmsvc_update_deferred_block(struct nlm_block *block, struct file_lock *conf,
 621                              int result)
 622 {
 623         block->b_flags |= B_GOT_CALLBACK;
 624         if (result == 0)
 625                 block->b_granted = 1;
 626         else
 627                 block->b_flags |= B_TIMED_OUT;
 628         if (conf) {
 629                 if (block->b_fl)
 630                         __locks_copy_lock(block->b_fl, conf);
 631         }
 632 }
 633
 634 static int nlmsvc_grant_deferred(struct file_lock *fl, struct file_lock *conf,
 635                                         int result)
 636 {
 637         struct nlm_block *block;
 638         int rc = -ENOENT;
 639
 640         lock_kernel();
 641         list_for_each_entry(block, &nlm_blocked, b_list) {
 642                 if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
 643                         dprintk("lockd: nlmsvc_notify_blocked block %p flags %d\n",
 644                                                         block, block->b_flags);
 645                         if (block->b_flags & B_QUEUED) {
 646                                 if (block->b_flags & B_TIMED_OUT) {
 647                                         rc = -ENOLCK;
 648                                         break;
 649                                 }
 650                                 nlmsvc_update_deferred_block(block, conf, result);
 651                         } else if (result == 0)
 652                                 block->b_granted = 1;
 653
 654                         nlmsvc_insert_block(block, 0);
 655                         svc_wake_up(block->b_daemon);
 656                         rc = 0;
 657                         break;
 658                 }
 659         }
 660         unlock_kernel();
 661         if (rc == -ENOENT)
 662                 printk(KERN_WARNING "lockd: grant for unknown block\n");
 663         return rc;
 664 }
 665
 666 /*
 667  * Unblock a blocked lock request. This is a callback invoked from the
 668  * VFS layer when a lock on which we blocked is removed.
 669  *
 670  * This function doesn't grant the blocked lock instantly, but rather moves
 671  * the block to the head of nlm_blocked where it can be picked up by lockd.
 672  */
 673 static void
 674 nlmsvc_notify_blocked(struct file_lock *fl)
 675 {
 676         struct nlm_block        *block;
 677
 678         dprintk("lockd: VFS unblock notification for block %p\n", fl);
 679         list_for_each_entry(block, &nlm_blocked, b_list) {
 680                 if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
 681                         nlmsvc_insert_block(block, 0);
 682                         svc_wake_up(block->b_daemon);
 683                         return;
 684                 }
 685         }
 686
 687         printk(KERN_WARNING "lockd: notification for unknown block!\n");
 688 }
 689
 690 static int nlmsvc_same_owner(struct file_lock *fl1, struct file_lock *fl2)
 691 {
 692         return fl1->fl_owner == fl2->fl_owner && fl1->fl_pid == fl2->fl_pid;
 693 }
 694
 695 struct lock_manager_operations nlmsvc_lock_operations = {
 696         .fl_compare_owner = nlmsvc_same_owner,
 697         .fl_notify = nlmsvc_notify_blocked,
 698         .fl_grant = nlmsvc_grant_deferred,
 699 };
 700
 701 /*
 702  * Try to claim a lock that was previously blocked.
 703  *
 704  * Note that we use both the RPC_GRANTED_MSG call _and_ an async
 705  * RPC thread when notifying the client. This seems like overkill...
 706  * Here's why:
 707  *  -   we don't want to use a synchronous RPC thread, otherwise
 708  *      we might find ourselves hanging on a dead portmapper.
 709  *  -   Some lockd implementations (e.g. HP) don't react to
 710  *      RPC_GRANTED calls; they seem to insist on RPC_GRANTED_MSG calls.
 711  */
 712 static void
 713 nlmsvc_grant_blocked(struct nlm_block *block)
 714 {
 715         struct nlm_file         *file = block->b_file;
 716         struct nlm_lock         *lock = &block->b_call->a_args.lock;
 717         int                     error;
 718
 719         dprintk("lockd: grant blocked lock %p\n", block);
 720
 721         kref_get(&block->b_count);
 722
 723         /* Unlink block request from list */
 724         nlmsvc_unlink_block(block);
 725
 726         /* If b_granted is true this means we've been here before.
 727          * Just retry the grant callback, possibly refreshing the RPC
 728          * binding */
 729         if (block->b_granted) {
 730                 nlm_rebind_host(block->b_host);
 731                 goto callback;
 732         }
 733
 734         /* Try the lock operation again */
 735         lock->fl.fl_flags |= FL_SLEEP;
 736         error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
 737         lock->fl.fl_flags &= ~FL_SLEEP;
 738
 739         switch (error) {
 740         case 0:
 741                 break;
 742         case FILE_LOCK_DEFERRED:
 743                 dprintk("lockd: lock still blocked error %d\n", error);
 744                 nlmsvc_insert_block(block, NLM_NEVER);
 745                 nlmsvc_release_block(block);
 746                 return;
 747         default:
 748                 printk(KERN_WARNING "lockd: unexpected error %d in %s!\n",
 749                                 -error, __func__);
 750                 nlmsvc_insert_block(block, 10 * HZ);
 751                 nlmsvc_release_block(block);
 752                 return;
 753         }
 754
 755 callback:
 756         /* Lock was granted by VFS. */
 757         dprintk("lockd: GRANTing blocked lock.\n");
 758         block->b_granted = 1;
 759
 760         /* keep block on the list, but don't reattempt until the RPC
 761          * completes or the submission fails
 762          */
 763         nlmsvc_insert_block(block, NLM_NEVER);
 764
 765         /* Call the client -- use a soft RPC task since nlmsvc_retry_blocked
 766          * will queue up a new one if this one times out
 767          */
 768         error = nlm_async_call(block->b_call, NLMPROC_GRANTED_MSG,
 769                                 &nlmsvc_grant_ops);
 770
 771         /* RPC submission failed, wait a bit and retry */
 772         if (error < 0)
 773                 nlmsvc_insert_block(block, 10 * HZ);
 774 }
 775
 776 /*
 777  * This is the callback from the RPC layer when the NLM_GRANTED_MSG
 778  * RPC call has succeeded or timed out.
 779  * Like all RPC callbacks, it is invoked by the rpciod process, so it
 780  * better not sleep. Therefore, we put the blocked lock on the nlm_blocked
 781  * chain once more in order to have it removed by lockd itself (which can
 782  * then sleep on the file semaphore without disrupting e.g. the nfs client).
 783  */
 784 static void nlmsvc_grant_callback(struct rpc_task *task, void *data)
 785 {
 786         struct nlm_rqst         *call = data;
 787         struct nlm_block        *block = call->a_block;
 788         unsigned long           timeout;
 789
 790         dprintk("lockd: GRANT_MSG RPC callback\n");
 791
 792         lock_kernel();
 793         /* if the block is not on a list at this point then it has
 794          * been invalidated. Don't try to requeue it.
 795          *
 796          * FIXME: it's possible that the block is removed from the list
 797          * after this check but before the nlmsvc_insert_block. In that
 798          * case it will be added back. Perhaps we need better locking
 799          * for nlm_blocked?
 800          */
 801         if (list_empty(&block->b_list))
 802                 goto out;
 803
 804         /* Technically, we should down the file semaphore here. Since we
 805          * move the block towards the head of the queue only, no harm
 806          * can be done, though. */
 807         if (task->tk_status < 0) {
 808                 /* RPC error: Re-insert for retransmission */
 809                 timeout = 10 * HZ;
 810         } else {
 811                 /* Call was successful, now wait for client callback */
 812                 timeout = 60 * HZ;
 813         }
 814         nlmsvc_insert_block(block, timeout);
 815         svc_wake_up(block->b_daemon);
 816 out:
 817         unlock_kernel();
 818 }
 819
 820 static void nlmsvc_grant_release(void *data)
 821 {
 822         struct nlm_rqst         *call = data;
 823
 824         lock_kernel();
 825         nlmsvc_release_block(call->a_block);
 826         unlock_kernel();
 827 }
 828
 829 static const struct rpc_call_ops nlmsvc_grant_ops = {
 830         .rpc_call_done = nlmsvc_grant_callback,
 831         .rpc_release = nlmsvc_grant_release,
 832 };
 833
 834 /*
 835  * We received a GRANT_RES callback. Try to find the corresponding
 836  * block.
 837  */
 838 void
 839 nlmsvc_grant_reply(struct nlm_cookie *cookie, __be32 status)
 840 {
 841         struct nlm_block        *block;
 842
 843         dprintk("grant_reply: looking for cookie %x, s=%d \n",
 844                 *(unsigned int *)(cookie->data), status);
 845         if (!(block = nlmsvc_find_block(cookie)))
 846                 return;
 847
 848         if (block) {
 849                 if (status == nlm_lck_denied_grace_period) {
 850                         /* Try again in a couple of seconds */
 851                         nlmsvc_insert_block(block, 10 * HZ);
 852                 } else {
 853                         /* Lock is now held by client, or has been rejected.
 854                          * In both cases, the block should be removed. */
 855                         nlmsvc_unlink_block(block);
 856                 }
 857         }
 858         nlmsvc_release_block(block);
 859 }
 860
 861 /* Helper function to handle retry of a deferred block.
 862  * If it is a blocking lock, call grant_blocked.
 863  * For a non-blocking lock or test lock, revisit the request.
 864  */
 865 static void
 866 retry_deferred_block(struct nlm_block *block)
 867 {
 868         if (!(block->b_flags & B_GOT_CALLBACK))
 869                 block->b_flags |= B_TIMED_OUT;
 870         nlmsvc_insert_block(block, NLM_TIMEOUT);
 871         dprintk("revisit block %p flags %d\n",  block, block->b_flags);
 872         if (block->b_deferred_req) {
 873                 block->b_deferred_req->revisit(block->b_deferred_req, 0);
 874                 block->b_deferred_req = NULL;
 875         }
 876 }
 877
 878 /*
 879  * Retry all blocked locks that have been notified. This is where lockd
 880  * picks up locks that can be granted, or grant notifications that must
 881  * be retransmitted.
 882  */
 883 unsigned long
 884 nlmsvc_retry_blocked(void)
 885 {
 886         unsigned long   timeout = MAX_SCHEDULE_TIMEOUT;
 887         struct nlm_block *block;
 888
 889         while (!list_empty(&nlm_blocked) && !kthread_should_stop()) {
 890                 block = list_entry(nlm_blocked.next, struct nlm_block, b_list);
 891
 892                 if (block->b_when == NLM_NEVER)
 893                         break;
 894                 if (time_after(block->b_when, jiffies)) {
 895                         timeout = block->b_when - jiffies;
 896                         break;
 897                 }
 898
 899                 dprintk("nlmsvc_retry_blocked(%p, when=%ld)\n",
 900                         block, block->b_when);
 901                 if (block->b_flags & B_QUEUED) {
 902                         dprintk("nlmsvc_retry_blocked delete block (%p, granted=%d, flags=%d)\n",
 903                                 block, block->b_granted, block->b_flags);
 904                         retry_deferred_block(block);
 905                 } else
 906                         nlmsvc_grant_blocked(block);
 907         }
 908
 909         return timeout;
 910 }