sys/kern/kern_lockf.c

   1 /*
   2  * Copyright (c) 2004 Joerg Sonnenberger <joerg@bec.de>.  All rights reserved.
   3  * Copyright (c) 2006 Matthew Dillon <dillon@backplane.com>.  All rights reserved.
   4  *
   5  * Copyright (c) 1982, 1986, 1989, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Scooter Morris at Genentech Inc.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      @(#)ufs_lockf.c 8.3 (Berkeley) 1/6/94
  40  * $FreeBSD: src/sys/kern/kern_lockf.c,v 1.25 1999/11/16 16:28:56 phk Exp $
  41  * $DragonFly: src/sys/kern/kern_lockf.c,v 1.32 2006/07/25 20:01:50 dillon Exp $
  42  */
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/kernel.h>
  47 #include <sys/lock.h>
  48 #include <sys/proc.h>
  49 #include <sys/unistd.h>
  50 #include <sys/vnode.h>
  51 #include <sys/malloc.h>
  52 #include <sys/fcntl.h>
  53 #include <sys/resourcevar.h>
  54
  55 #include <sys/lockf.h>
  56 #include <machine/limits.h>     /* for LLONG_MAX */
  57 #include <machine/stdarg.h>
  58
  59 #ifdef INVARIANTS
  60 int lf_global_counter = 0;
  61 #endif
  62
  63 #ifdef LOCKF_DEBUG
  64 int lf_print_ranges = 0;
  65
  66 static void _lf_print_lock(const struct lockf *);
  67 static void _lf_printf(const char *, ...);
  68
  69 #define lf_print_lock(lock) if (lf_print_ranges) _lf_print_lock(lock)
  70 #define lf_printf(ctl, args...) if (lf_print_ranges) _lf_printf(ctl, args)
  71 #else
  72 #define lf_print_lock(lock)
  73 #define lf_printf(ctl, args...)
  74 #endif
  75
  76 static MALLOC_DEFINE(M_LOCKF, "lockf", "Byte-range locking structures");
  77
  78 static void     lf_wakeup(struct lockf *, off_t, off_t);
  79 static struct lockf_range *lf_alloc_range(void);
  80 static void     lf_create_range(struct lockf_range *, struct proc *, int, int,
  81                                 off_t, off_t);
  82 static void     lf_insert(struct lockf_range_list *list,
  83                                 struct lockf_range *elm,
  84                                 struct lockf_range *insert_point);
  85 static void     lf_destroy_range(struct lockf_range *);
  86
  87 static int      lf_setlock(struct lockf *, struct proc *, int, int,
  88                            off_t, off_t);
  89 static int      lf_getlock(struct flock *, struct lockf *, struct proc *,
  90                            int, int, off_t, off_t);
  91
  92 static int      lf_count_change(struct proc *, int);
  93
  94 /*
  95  * Return TRUE (non-zero) if the type and posix flags match.
  96  */
  97 static __inline
  98 int
  99 lf_match(struct lockf_range *range, int type, int flags)
 100 {
 101         if (range->lf_type != type)
 102                 return(0);
 103         if ((range->lf_flags ^ flags) & F_POSIX)
 104                 return(0);
 105         return(1);
 106 }
 107
 108 /*
 109  * Check whether range and [start, end] overlap.
 110  */
 111 static __inline
 112 int
 113 lf_overlap(const struct lockf_range *range, off_t start, off_t end)
 114 {
 115         if (range->lf_start >= start && range->lf_start <= end)
 116                 return(1);
 117         else if (start >= range->lf_start && start <= range->lf_end)
 118                 return(1);
 119         else
 120                 return(0);
 121 }
 122
 123
 124 /*
 125  * Change the POSIX lock accounting for the given process.
 126  */
 127 void
 128 lf_count_adjust(struct proc *p, int increase)
 129 {
 130         struct uidinfo *uip;
 131
 132         KKASSERT(p != NULL);
 133
 134         uip = p->p_ucred->cr_uidinfo;
 135
 136         if (increase)
 137                 uip->ui_posixlocks += p->p_numposixlocks;
 138         else
 139                 uip->ui_posixlocks -= p->p_numposixlocks;
 140
 141         KASSERT(uip->ui_posixlocks >= 0,
 142                 ("Negative number of POSIX locks held by %s user: %d.",
 143                  increase ? "new" : "old", uip->ui_posixlocks));
 144 }
 145
 146 static int
 147 lf_count_change(struct proc *owner, int diff)
 148 {
 149         struct uidinfo *uip;
 150         int max;
 151
 152         /* we might actually not have a process context */
 153         if (owner == NULL)
 154                 return(0);
 155
 156         uip = owner->p_ucred->cr_uidinfo;
 157
 158         max = MIN(owner->p_rlimit[RLIMIT_POSIXLOCKS].rlim_cur,
 159                   maxposixlocksperuid);
 160         if (diff > 0 && owner->p_ucred->cr_uid != 0 && max != -1 &&
 161             uip->ui_posixlocks >= max ) {
 162                 return(1);
 163         }
 164
 165         uip->ui_posixlocks += diff;
 166         owner->p_numposixlocks += diff;
 167
 168         KASSERT(uip->ui_posixlocks >= 0,
 169                 ("Negative number of POSIX locks held by user: %d.",
 170                  uip->ui_posixlocks));
 171         KASSERT(owner->p_numposixlocks >= 0,
 172                 ("Negative number of POSIX locks held by proc: %d.",
 173                  uip->ui_posixlocks));
 174
 175         return(0);
 176 }
 177
 178 /*
 179  * Advisory record locking support
 180  */
 181 int
 182 lf_advlock(struct vop_advlock_args *ap, struct lockf *lock, u_quad_t size)
 183 {
 184         struct flock *fl = ap->a_fl;
 185         struct proc *owner;
 186         off_t start, end;
 187         int type, flags, error;
 188         lwkt_tokref ilock;
 189
 190         /*
 191          * Convert the flock structure into a start and end.
 192          */
 193         switch (fl->l_whence) {
 194         case SEEK_SET:
 195         case SEEK_CUR:
 196                 /*
 197                  * Caller is responsible for adding any necessary offset
 198                  * when SEEK_CUR is used.
 199                  */
 200                 start = fl->l_start;
 201                 break;
 202
 203         case SEEK_END:
 204                 start = size + fl->l_start;
 205                 break;
 206
 207         default:
 208                 return(EINVAL);
 209         }
 210         if (start < 0)
 211                 return(EINVAL);
 212         if (fl->l_len == 0) {
 213                 flags |= F_NOEND;
 214                 end = LLONG_MAX;
 215         } else {
 216                 end = start + fl->l_len - 1;
 217                 if (end < start)
 218                         return(EINVAL);
 219         }
 220
 221         flags = ap->a_flags;
 222         type = fl->l_type;
 223         /*
 224          * This isn't really correct for flock-style locks,
 225          * but the current handling is somewhat broken anyway.
 226          */
 227         owner = (struct proc *)ap->a_id;
 228
 229         /*
 230          * Do the requested operation.
 231          */
 232         lwkt_gettoken(&ilock, lwkt_token_pool_get(lock));
 233
 234         if (lock->init_done == 0) {
 235                 TAILQ_INIT(&lock->lf_range);
 236                 TAILQ_INIT(&lock->lf_blocked);
 237                 lock->init_done = 1;
 238         }
 239
 240         switch(ap->a_op) {
 241         case F_SETLK:
 242                 /*
 243                  * NOTE: It is possible for both lf_range and lf_blocked to
 244                  * be empty if we block and get woken up, but another process
 245                  * then gets in and issues an unlock.  So VMAYHAVELOCKS must
 246                  * be set after the lf_setlock() operation completes rather
 247                  * then before.
 248                  */
 249                 error = lf_setlock(lock, owner, type, flags, start, end);
 250                 ap->a_vp->v_flag |= VMAYHAVELOCKS;
 251                 break;
 252
 253         case F_UNLCK:
 254                 error = lf_setlock(lock, owner, type, flags, start, end);
 255                 if (TAILQ_EMPTY(&lock->lf_range) &&
 256                     TAILQ_EMPTY(&lock->lf_blocked)) {
 257                         ap->a_vp->v_flag &= ~VMAYHAVELOCKS;
 258                 }
 259                 break;
 260
 261         case F_GETLK:
 262                 error = lf_getlock(fl, lock, owner, type, flags, start, end);
 263                 break;
 264
 265         default:
 266                 error = EINVAL;
 267                 break;
 268         }
 269         lwkt_reltoken(&ilock);
 270         return(error);
 271 }
 272
 273 static int
 274 lf_setlock(struct lockf *lock, struct proc *owner, int type, int flags,
 275            off_t start, off_t end)
 276 {
 277         struct lockf_range *range;
 278         struct lockf_range *brange;
 279         struct lockf_range *next;
 280         struct lockf_range *first_match;
 281         struct lockf_range *last_match;
 282         struct lockf_range *insert_point;
 283         struct lockf_range *new_range1;
 284         struct lockf_range *new_range2;
 285         int wakeup_needed;
 286         int double_clip;
 287         int error = 0;
 288         int count;
 289         struct lockf_range_list deadlist;
 290
 291         new_range1 = NULL;
 292         new_range2 = NULL;
 293         count = 0;
 294
 295 restart:
 296         /*
 297          * Preallocate two ranges so we don't have to worry about blocking
 298          * in the middle of the lock code.
 299          */
 300         if (new_range1 == NULL)
 301                 new_range1 = lf_alloc_range();
 302         if (new_range2 == NULL)
 303                 new_range2 = lf_alloc_range();
 304         first_match = NULL;
 305         last_match = NULL;
 306         insert_point = NULL;
 307         wakeup_needed = 0;
 308
 309         lf_print_lock(lock);
 310
 311         /*
 312          * Locate the insertion point for the new lock (the first range
 313          * with an lf_start >= start).
 314          *
 315          * Locate the first and latch ranges owned by us that overlap
 316          * the requested range.
 317          */
 318         TAILQ_FOREACH(range, &lock->lf_range, lf_link) {
 319                 if (insert_point == NULL && range->lf_start >= start)
 320                         insert_point = range;
 321
 322                 /*
 323                  * Skip non-overlapping locks.  Locks are sorted by lf_start
 324                  * So we can terminate the search when lf_start exceeds the
 325                  * requested range (insert_point is still guarenteed to be
 326                  * set properly).
 327                  */
 328                 if (range->lf_end < start)
 329                         continue;
 330                 if (range->lf_start > end) {
 331                         range = NULL;
 332                         break;
 333                 }
 334
 335                 /*
 336                  * Overlapping lock.  Set first_match and last_match if we
 337                  * are the owner.
 338                  */
 339                 if (range->lf_owner == owner) {
 340                         if (first_match == NULL)
 341                                 first_match = range;
 342                         last_match = range;
 343                         continue;
 344                 }
 345
 346                 /*
 347                  * If we aren't the owner check for a conflicting lock.  Only
 348                  * if not unlocking.
 349                  */
 350                 if (type != F_UNLCK) {
 351                         if (type == F_WRLCK || range->lf_type == F_WRLCK)
 352                                 break;
 353                 }
 354         }
 355
 356         /*
 357          * If a conflicting lock was observed, block or fail as appropriate.
 358          * (this code is skipped when unlocking)
 359          */
 360         if (range != NULL) {
 361                 if ((flags & F_WAIT) == 0) {
 362                         error = EAGAIN;
 363                         goto do_cleanup;
 364                 }
 365
 366                 /*
 367                  * We are blocked. For POSIX locks we have to check
 368                  * for deadlocks and return with EDEADLK. This is done
 369                  * by checking whether range->lf_owner is already
 370                  * blocked.
 371                  *
 372                  * Since flock-style locks cover the whole file, a
 373                  * deadlock between those is nearly impossible.
 374                  * This can only occur if a process tries to lock the
 375                  * same inode exclusively while holding a shared lock
 376                  * with another descriptor.
 377                  * XXX How can we cleanly detect this?
 378                  * XXX The current mixing of flock & fcntl/lockf is evil.
 379                  *
 380                  * Handle existing locks of flock-style like POSIX locks.
 381                  */
 382                 if (flags & F_POSIX) {
 383                         TAILQ_FOREACH(brange, &lock->lf_blocked, lf_link)
 384                                 if (brange->lf_owner == range->lf_owner) {
 385                                         error = EDEADLK;
 386                                         goto do_cleanup;
 387                                 }
 388                 }
 389
 390                 /*
 391                  * For flock-style locks, we must first remove
 392                  * any shared locks that we hold before we sleep
 393                  * waiting for an exclusive lock.
 394                  */
 395                 if ((flags & F_POSIX) == 0 && type == F_WRLCK)
 396                         lf_setlock(lock, owner, F_UNLCK, 0, start, end);
 397
 398                 brange = new_range1;
 399                 new_range1 = NULL;
 400                 lf_create_range(brange, owner, type, 0, start, end);
 401                 TAILQ_INSERT_TAIL(&lock->lf_blocked, brange, lf_link);
 402                 error = tsleep(brange, PCATCH, "lockf", 0);
 403
 404                 /*
 405                  * We may have been awaked by a signal and/or by a
 406                  * debugger continuing us (in which case we must remove
 407                  * ourselves from the blocked list) and/or by another
 408                  * process releasing/downgrading a lock (in which case
 409                  * we have already been removed from the blocked list
 410                  * and our lf_flags field is 1).
 411                  *
 412                  * Sleep if it looks like we might be livelocking.
 413                  */
 414                 if (brange->lf_flags == 0)
 415                         TAILQ_REMOVE(&lock->lf_blocked, brange, lf_link);
 416                 if (count == 2)
 417                         tsleep(brange, 0, "lockfz", 2);
 418                 else
 419                         ++count;
 420                 lf_destroy_range(brange);
 421
 422                 if (error)
 423                         goto do_cleanup;
 424                 goto restart;
 425         }
 426
 427         /*
 428          * If there are no overlapping locks owned by us then creating
 429          * the new lock is easy.  This is the most common case.
 430          */
 431         if (first_match == NULL) {
 432                 if (type == F_UNLCK)
 433                         goto do_wakeup;
 434                 if (flags & F_POSIX) {
 435                         if (lf_count_change(owner, 1)) {
 436                                 error = ENOLCK;
 437                                 goto do_cleanup;
 438                         }
 439                 }
 440                 range = new_range1;
 441                 new_range1 = NULL;
 442                 lf_create_range(range, owner, type, flags, start, end);
 443                 lf_insert(&lock->lf_range, range, insert_point);
 444                 goto do_wakeup;
 445         }
 446
 447         /*
 448          * This is a special case that we need to check for in a couple
 449          * of places.
 450          */
 451         if (first_match == last_match && first_match->lf_start < start &&
 452             last_match->lf_end > end) {
 453                 double_clip = 1;
 454         } else {
 455                 double_clip = 0;
 456         }
 457
 458         /*
 459          * Figure out the worst case net increase in POSIX locks and account
 460          * for it now before we start modifying things.  If neither the
 461          * first or last locks match we have an issue.  If there is only
 462          * one overlapping range which needs to be clipped on both ends
 463          * we wind up having to create up to two new locks, else only one.
 464          *
 465          * When unlocking the worst case is always 1 new lock if our
 466          * unlock request cuts the middle out of an existing lock range.
 467          *
 468          * count represents the 'cleanup' adjustment needed.  It starts
 469          * negative, is incremented whenever we create a new POSIX lock,
 470          * and decremented whenever we delete an existing one.  At the
 471          * end of the day it had better be <= 0 or we didn't calculate the
 472          * worse case properly here.
 473          */
 474         count = 0;
 475         if (flags & F_POSIX) {
 476                 if (!lf_match(first_match, type, flags) &&
 477                     !lf_match(last_match, type, flags)
 478                 ) {
 479                         if (double_clip && type != F_UNLCK)
 480                                 count = -2;
 481                         else
 482                                 count = -1;
 483                 }
 484                 if (count && lf_count_change(owner, -count)) {
 485                         error = ENOLCK;
 486                         goto do_cleanup;
 487                 }
 488         }
 489         /* else flock style lock which encompasses entire range */
 490
 491         /*
 492          * Create and insert the lock represented the requested range.
 493          * Adjust the net POSIX lock count.  We have to move our insertion
 494          * point since brange now represents the first record >= start.
 495          *
 496          * When unlocking, no new lock is inserted but we still clip.
 497          */
 498         if (type != F_UNLCK) {
 499                 brange = new_range1;
 500                 new_range1 = NULL;
 501                 lf_create_range(brange, owner, type, flags, start, end);
 502                 lf_insert(&lock->lf_range, brange, insert_point);
 503                 insert_point = brange;
 504                 if (flags & F_POSIX)
 505                         ++count;
 506         } else {
 507                 brange = NULL;
 508         }
 509
 510         /*
 511          * Handle the double_clip case.  This is the only case where
 512          * we wind up having to add TWO locks.
 513          */
 514         if (double_clip) {
 515                 KKASSERT(first_match == last_match);
 516                 last_match = new_range2;
 517                 new_range2 = NULL;
 518                 lf_create_range(last_match, first_match->lf_owner,
 519                                 first_match->lf_type, first_match->lf_flags,
 520                                 end + 1, first_match->lf_end);
 521                 first_match->lf_end = start - 1;
 522                 first_match->lf_flags &= ~F_NOEND;
 523
 524                 /*
 525                  * Figure out where to insert the right side clip.
 526                  */
 527                 lf_insert(&lock->lf_range, last_match, first_match);
 528                 if (last_match->lf_flags & F_POSIX)
 529                         ++count;
 530         }
 531
 532         /*
 533          * Clip or destroy the locks between first_match and last_match,
 534          * inclusive.  Ignore the primary lock we created (brange).  Note
 535          * that if double-clipped, first_match and last_match will be
 536          * outside our clipping range.  Otherwise first_match and last_match
 537          * will be deleted.
 538          *
 539          * We have already taken care of any double clipping.
 540          *
 541          * The insert_point may become invalid as we delete records, do not
 542          * use that pointer any more.  Also, when removing something other
 543          * then 'range' we have to check to see if the item we are removing
 544          * is 'next' and adjust 'next' properly.
 545          *
 546          * NOTE: brange will be NULL if F_UNLCKing.
 547          */
 548         TAILQ_INIT(&deadlist);
 549         next = first_match;
 550
 551         while ((range = next) != NULL) {
 552                 next = TAILQ_NEXT(range, lf_link);
 553
 554                 /*
 555                  * Ignore elements that we do not own and ignore the
 556                  * primary request range which we just created.
 557                  */
 558                 if (range->lf_owner != owner || range == brange)
 559                         continue;
 560
 561                 /*
 562                  * We may have to wakeup a waiter when downgrading a lock.
 563                  */
 564                 if (type == F_UNLCK)
 565                         wakeup_needed = 1;
 566                 if (type == F_RDLCK && range->lf_type == F_WRLCK)
 567                         wakeup_needed = 1;
 568
 569                 /*
 570                  * Clip left.  This can only occur on first_match.
 571                  *
 572                  * Merge the left clip with brange if possible.  This must
 573                  * be done specifically, not in the optimized merge heuristic
 574                  * below, since we may have counted on it in our 'count'
 575                  * calculation above.
 576                  */
 577                 if (range->lf_start < start) {
 578                         KKASSERT(range == first_match);
 579                         if (brange &&
 580                             range->lf_end >= start - 1 &&
 581                             lf_match(range, type, flags)) {
 582                                 range->lf_end = brange->lf_end;
 583                                 range->lf_flags |= brange->lf_flags & F_NOEND;
 584                                 /*
 585                                  * Removing something other then 'range',
 586                                  * adjust 'next' if necessary.
 587                                  */
 588                                 if (next == brange)
 589                                         next = TAILQ_NEXT(next, lf_link);
 590                                 TAILQ_REMOVE(&lock->lf_range, brange, lf_link);
 591                                 if (brange->lf_flags & F_POSIX)
 592                                         --count;
 593                                 TAILQ_INSERT_TAIL(&deadlist, brange, lf_link);
 594                                 brange = range;
 595                         } else if (range->lf_end >= start) {
 596                                 range->lf_end = start - 1;
 597                                 if (type != F_UNLCK)
 598                                         range->lf_flags &= ~F_NOEND;
 599                         }
 600                         if (range == last_match)
 601                                 break;
 602                         continue;
 603                 }
 604
 605                 /*
 606                  * Clip right.  This can only occur on last_match.
 607                  *
 608                  * Merge the right clip if possible.  This must be done
 609                  * specifically, not in the optimized merge heuristic
 610                  * below, since we may have counted on it in our 'count'
 611                  * calculation.
 612                  *
 613                  * Since we are adjusting lf_start, we have to move the
 614                  * record to maintain the sorted list.  Since lf_start is
 615                  * only getting larger we can use the next element as the
 616                  * insert point (we don't have to backtrack).
 617                  */
 618                 if (range->lf_end > end) {
 619                         KKASSERT(range == last_match);
 620                         if (brange &&
 621                             range->lf_start <= end + 1 &&
 622                             lf_match(range, type, flags)) {
 623                                 brange->lf_end = range->lf_end;
 624                                 brange->lf_flags |= range->lf_flags & F_NOEND;
 625                                 TAILQ_REMOVE(&lock->lf_range, range, lf_link);
 626                                 if (range->lf_flags & F_POSIX)
 627                                         --count;
 628                                 TAILQ_INSERT_TAIL(&deadlist, range, lf_link);
 629                         } else if (range->lf_start <= end) {
 630                                 range->lf_start = end + 1;
 631                                 TAILQ_REMOVE(&lock->lf_range, range, lf_link);
 632                                 lf_insert(&lock->lf_range, range, next);
 633                         }
 634                         /* range == last_match, we are done */
 635                         break;
 636                 }
 637
 638                 /*
 639                  * The record must be entirely enclosed.  Note that the
 640                  * record could be first_match or last_match, and will be
 641                  * deleted.
 642                  */
 643                 KKASSERT(range->lf_start >= start && range->lf_end <= end);
 644                 TAILQ_REMOVE(&lock->lf_range, range, lf_link);
 645                 if (range->lf_flags & F_POSIX)
 646                         --count;
 647                 TAILQ_INSERT_TAIL(&deadlist, range, lf_link);
 648                 if (range == last_match)
 649                         break;
 650         }
 651
 652         /*
 653          * Attempt to merge locks adjacent to brange.  For example, we may
 654          * have had to clip first_match and/or last_match, and they might
 655          * be adjacent.  Or there might simply have been an adjacent lock
 656          * already there.
 657          *
 658          * Don't get fancy, just check adjacent elements in the list if they
 659          * happen to be owned by us.
 660          *
 661          * This case only gets hit if we have a situation where a shared
 662          * and exclusive lock are adjacent, and the exclusive lock is
 663          * downgraded to shared or the shared lock is upgraded to exclusive.
 664          */
 665         if (brange) {
 666                 range = TAILQ_PREV(brange, lockf_range_list, lf_link);
 667                 if (range &&
 668                     range->lf_owner == owner &&
 669                     range->lf_end == brange->lf_start - 1 &&
 670                     lf_match(range, type, flags)
 671                 ) {
 672                         /*
 673                          * Extend range to cover brange and scrap brange.
 674                          */
 675                         range->lf_end = brange->lf_end;
 676                         range->lf_flags |= brange->lf_flags & F_NOEND;
 677                         TAILQ_REMOVE(&lock->lf_range, brange, lf_link);
 678                         if (brange->lf_flags & F_POSIX)
 679                                 --count;
 680                         TAILQ_INSERT_TAIL(&deadlist, brange, lf_link);
 681                         brange = range;
 682                 }
 683                 range = TAILQ_NEXT(brange, lf_link);
 684                 if (range &&
 685                     range->lf_owner == owner &&
 686                     range->lf_start == brange->lf_end + 1 &&
 687                     lf_match(range, type, flags)
 688                 ) {
 689                         /*
 690                          * Extend brange to cover range and scrap range.
 691                          */
 692                         brange->lf_end = range->lf_end;
 693                         brange->lf_flags |= range->lf_flags & F_NOEND;
 694                         TAILQ_REMOVE(&lock->lf_range, range, lf_link);
 695                         if (range->lf_flags & F_POSIX)
 696                                 --count;
 697                         TAILQ_INSERT_TAIL(&deadlist, range, lf_link);
 698                 }
 699         }
 700
 701         /*
 702          * Destroy deleted elements.  We didn't want to do it in the loop
 703          * because the free() might have blocked.
 704          *
 705          * Adjust the count for any posix locks we thought we might create
 706          * but didn't.
 707          */
 708         while ((range = TAILQ_FIRST(&deadlist)) != NULL) {
 709                 TAILQ_REMOVE(&deadlist, range, lf_link);
 710                 lf_destroy_range(range);
 711         }
 712
 713         KKASSERT(count <= 0);
 714         if (count < 0)
 715                 lf_count_change(owner, count);
 716 do_wakeup:
 717         lf_print_lock(lock);
 718         if (wakeup_needed)
 719                 lf_wakeup(lock, start, end);
 720         error = 0;
 721 do_cleanup:
 722         if (new_range1 != NULL)
 723                 lf_destroy_range(new_range1);
 724         if (new_range2 != NULL)
 725                 lf_destroy_range(new_range2);
 726         return(error);
 727 }
 728
 729 /*
 730  * Check whether there is a blocking lock,
 731  * and if so return its process identifier.
 732  */
 733 static int
 734 lf_getlock(struct flock *fl, struct lockf *lock, struct proc *owner,
 735            int type, int flags, off_t start, off_t end)
 736 {
 737         struct lockf_range *range;
 738
 739         TAILQ_FOREACH(range, &lock->lf_range, lf_link)
 740                 if (range->lf_owner != owner &&
 741                     lf_overlap(range, start, end) &&
 742                     (type == F_WRLCK || range->lf_type == F_WRLCK))
 743                         break;
 744         if (range == NULL) {
 745                 fl->l_type = F_UNLCK;
 746                 return(0);
 747         }
 748         fl->l_type = range->lf_type;
 749         fl->l_whence = SEEK_SET;
 750         fl->l_start = range->lf_start;
 751         if (range->lf_flags & F_NOEND)
 752                 fl->l_len = 0;
 753         else
 754                 fl->l_len = range->lf_end - range->lf_start + 1;
 755         if (range->lf_owner != NULL && (range->lf_flags & F_POSIX))
 756                 fl->l_pid = range->lf_owner->p_pid;
 757         else
 758                 fl->l_pid = -1;
 759         return(0);
 760 }
 761
 762 /*
 763  * Wakeup pending lock attempts.
 764  */
 765 static void
 766 lf_wakeup(struct lockf *lock, off_t start, off_t end)
 767 {
 768         struct lockf_range *range, *nrange;
 769         TAILQ_FOREACH_MUTABLE(range, &lock->lf_blocked, lf_link, nrange) {
 770                 if (lf_overlap(range, start, end) == 0)
 771                         continue;
 772                 TAILQ_REMOVE(&lock->lf_blocked, range, lf_link);
 773                 range->lf_flags = 1;
 774                 wakeup(range);
 775                 if (range->lf_start >= start && range->lf_end <= end)
 776                         break;
 777         }
 778 }
 779
 780 /*
 781  * Allocate a range structure and initialize it sufficiently such that
 782  * lf_destroy_range() does not barf.
 783  */
 784 static struct lockf_range *
 785 lf_alloc_range(void)
 786 {
 787         struct lockf_range *range;
 788
 789 #ifdef INVARIANTS
 790         lf_global_counter++;
 791 #endif
 792         range = malloc(sizeof(struct lockf_range), M_LOCKF, M_WAITOK);
 793         range->lf_owner = NULL;
 794         return(range);
 795 }
 796
 797 static void
 798 lf_insert(struct lockf_range_list *list, struct lockf_range *elm,
 799           struct lockf_range *insert_point)
 800 {
 801         while (insert_point && insert_point->lf_start < elm->lf_start)
 802                 insert_point = TAILQ_NEXT(insert_point, lf_link);
 803         if (insert_point != NULL)
 804                 TAILQ_INSERT_BEFORE(insert_point, elm, lf_link);
 805         else
 806                 TAILQ_INSERT_TAIL(list, elm, lf_link);
 807 }
 808
 809 static void
 810 lf_create_range(struct lockf_range *range, struct proc *owner, int type,
 811                 int flags, off_t start, off_t end)
 812 {
 813         KKASSERT(start <= end);
 814         range->lf_type = type;
 815         range->lf_flags = flags;
 816         range->lf_start = start;
 817         range->lf_end = end;
 818         range->lf_owner = owner;
 819
 820         lf_printf("lf_create_range: %lld..%lld\n",
 821                         range->lf_start, range->lf_end);
 822 }
 823
 824 static void
 825 lf_destroy_range(struct lockf_range *range)
 826 {
 827         lf_printf("lf_destroy_range: %lld..%lld\n",
 828                   range->lf_start, range->lf_end);
 829         free(range, M_LOCKF);
 830 #ifdef INVARIANTS
 831         lf_global_counter--;
 832         KKASSERT(lf_global_counter>=0);
 833 #endif
 834 }
 835
 836 #ifdef LOCKF_DEBUG
 837
 838 static void
 839 _lf_printf(const char *ctl, ...)
 840 {
 841         struct proc *p;
 842         __va_list va;
 843
 844         if (lf_print_ranges) {
 845             if ((p = curproc) != NULL)
 846                 printf("pid %d (%s): ", p->p_pid, p->p_comm);
 847         }
 848         __va_start(va, ctl);
 849         vprintf(ctl, va);
 850         __va_end(va);
 851 }
 852
 853 static void
 854 _lf_print_lock(const struct lockf *lock)
 855 {
 856         struct lockf_range *range;
 857
 858         if (lf_print_ranges == 0)
 859                 return;
 860
 861         if (TAILQ_EMPTY(&lock->lf_range)) {
 862                 lf_printf("lockf %p: no ranges locked\n", lock);
 863         } else {
 864                 lf_printf("lockf %p:\n", lock);
 865         }
 866         TAILQ_FOREACH(range, &lock->lf_range, lf_link)
 867                 printf("\t%lld..%lld type %s owned by %d\n",
 868                        range->lf_start, range->lf_end,
 869                        range->lf_type == F_RDLCK ? "shared" : "exclusive",
 870                        range->lf_flags & F_POSIX ? range->lf_owner->p_pid : -1);
 871         if (TAILQ_EMPTY(&lock->lf_blocked))
 872                 printf("no process waiting for range\n");
 873         else
 874                 printf("blocked locks:");
 875         TAILQ_FOREACH(range, &lock->lf_blocked, lf_link)
 876                 printf("\t%lld..%lld type %s waiting on %p\n",
 877                        range->lf_start, range->lf_end,
 878                        range->lf_type == F_RDLCK ? "shared" : "exclusive",
 879                        range);
 880 }
 881 #endif /* LOCKF_DEBUG */