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.28 2006/05/08 00:38:58 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                 error = lf_setlock(lock, owner, type, flags, start, end);
 243                 break;
 244
 245         case F_UNLCK:
 246                 error = lf_setlock(lock, owner, type, flags, start, end);
 247                 break;
 248
 249         case F_GETLK:
 250                 error = lf_getlock(fl, lock, owner, type, flags, start, end);
 251                 break;
 252
 253         default:
 254                 error = EINVAL;
 255                 break;
 256         }
 257         lwkt_reltoken(&ilock);
 258         return(error);
 259 }
 260
 261 static int
 262 lf_setlock(struct lockf *lock, struct proc *owner, int type, int flags,
 263            off_t start, off_t end)
 264 {
 265         struct lockf_range *range;
 266         struct lockf_range *brange;
 267         struct lockf_range *next;
 268         struct lockf_range *first_match;
 269         struct lockf_range *last_match;
 270         struct lockf_range *insert_point;
 271         struct lockf_range *new_range1;
 272         struct lockf_range *new_range2;
 273         int wakeup_needed;
 274         int double_clip;
 275         int error = 0;
 276         int count;
 277         struct lockf_range_list deadlist;
 278
 279         new_range1 = NULL;
 280         new_range2 = NULL;
 281         count = 0;
 282
 283 restart:
 284         /*
 285          * Preallocate two ranges so we don't have to worry about blocking
 286          * in the middle of the lock code.
 287          */
 288         if (new_range1 == NULL)
 289                 new_range1 = lf_alloc_range();
 290         if (new_range2 == NULL)
 291                 new_range2 = lf_alloc_range();
 292         first_match = NULL;
 293         last_match = NULL;
 294         insert_point = NULL;
 295         wakeup_needed = 0;
 296
 297         lf_print_lock(lock);
 298
 299         /*
 300          * Locate the insertion point for the new lock (the first range
 301          * with an lf_start >= start).
 302          *
 303          * Locate the first and latch ranges owned by us that overlap
 304          * the requested range.
 305          */
 306         TAILQ_FOREACH(range, &lock->lf_range, lf_link) {
 307                 if (insert_point == NULL && range->lf_start >= start)
 308                         insert_point = range;
 309
 310                 /*
 311                  * Skip non-overlapping locks.  Locks are sorted by lf_start
 312                  * So we can terminate the search when lf_start exceeds the
 313                  * requested range (insert_point is still guarenteed to be
 314                  * set properly).
 315                  */
 316                 if (range->lf_end < start)
 317                         continue;
 318                 if (range->lf_start > end) {
 319                         range = NULL;
 320                         break;
 321                 }
 322
 323                 /*
 324                  * Overlapping lock.  Set first_match and last_match if we
 325                  * are the owner.
 326                  */
 327                 if (range->lf_owner == owner) {
 328                         if (first_match == NULL)
 329                                 first_match = range;
 330                         last_match = range;
 331                         continue;
 332                 }
 333
 334                 /*
 335                  * If we aren't the owner check for a conflicting lock.  Only
 336                  * if not unlocking.
 337                  */
 338                 if (type != F_UNLCK) {
 339                         if (type == F_WRLCK || range->lf_type == F_WRLCK)
 340                                 break;
 341                 }
 342         }
 343
 344         /*
 345          * If a conflicting lock was observed, block or fail as appropriate.
 346          * (this code is skipped when unlocking)
 347          */
 348         if (range != NULL) {
 349                 if ((flags & F_WAIT) == 0) {
 350                         error = EAGAIN;
 351                         goto do_cleanup;
 352                 }
 353
 354                 /*
 355                  * We are blocked. For POSIX locks we have to check
 356                  * for deadlocks and return with EDEADLK. This is done
 357                  * by checking whether range->lf_owner is already
 358                  * blocked.
 359                  *
 360                  * Since flock-style locks cover the whole file, a
 361                  * deadlock between those is nearly impossible.
 362                  * This can only occur if a process tries to lock the
 363                  * same inode exclusively while holding a shared lock
 364                  * with another descriptor.
 365                  * XXX How can we cleanly detect this?
 366                  * XXX The current mixing of flock & fcntl/lockf is evil.
 367                  *
 368                  * Handle existing locks of flock-style like POSIX locks.
 369                  */
 370                 if (flags & F_POSIX) {
 371                         TAILQ_FOREACH(brange, &lock->lf_blocked, lf_link)
 372                                 if (brange->lf_owner == range->lf_owner) {
 373                                         error = EDEADLK;
 374                                         goto do_cleanup;
 375                                 }
 376                 }
 377
 378                 /*
 379                  * For flock-style locks, we must first remove
 380                  * any shared locks that we hold before we sleep
 381                  * waiting for an exclusive lock.
 382                  */
 383                 if ((flags & F_POSIX) == 0 && type == F_WRLCK)
 384                         lf_setlock(lock, owner, F_UNLCK, 0, start, end);
 385
 386                 brange = new_range1;
 387                 new_range1 = NULL;
 388                 lf_create_range(brange, owner, type, 0, start, end);
 389                 TAILQ_INSERT_TAIL(&lock->lf_blocked, brange, lf_link);
 390                 error = tsleep(brange, PCATCH, "lockf", 0);
 391
 392                 /*
 393                  * We may have been awaked by a signal and/or by a
 394                  * debugger continuing us (in which case we must remove
 395                  * ourselves from the blocked list) and/or by another
 396                  * process releasing/downgrading a lock (in which case
 397                  * we have already been removed from the blocked list
 398                  * and our lf_flags field is 1).
 399                  *
 400                  * Sleep if it looks like we might be livelocking.
 401                  */
 402                 if (brange->lf_flags == 0)
 403                         TAILQ_REMOVE(&lock->lf_blocked, brange, lf_link);
 404                 if (count == 2)
 405                         tsleep(brange, 0, "lockfz", 2);
 406                 else
 407                         ++count;
 408                 lf_destroy_range(brange);
 409
 410                 if (error)
 411                         goto do_cleanup;
 412                 goto restart;
 413         }
 414
 415         /*
 416          * If there are no overlapping locks owned by us then creating
 417          * the new lock is easy.  This is the most common case.
 418          */
 419         if (first_match == NULL) {
 420                 if (type == F_UNLCK)
 421                         goto do_wakeup;
 422                 if (flags & F_POSIX) {
 423                         if (lf_count_change(owner, 1)) {
 424                                 error = ENOLCK;
 425                                 goto do_cleanup;
 426                         }
 427                 }
 428                 range = new_range1;
 429                 new_range1 = NULL;
 430                 lf_create_range(range, owner, type, flags, start, end);
 431                 lf_insert(&lock->lf_range, range, insert_point);
 432                 goto do_wakeup;
 433         }
 434
 435         /*
 436          * This is a special case that we need to check for in a couple
 437          * of places.
 438          */
 439         if (first_match == last_match && first_match->lf_start < start &&
 440             last_match->lf_end > end) {
 441                 double_clip = 1;
 442         } else {
 443                 double_clip = 0;
 444         }
 445
 446         /*
 447          * Figure out the worst case net increase in POSIX locks and account
 448          * for it now before we start modifying things.  If neither the
 449          * first or last locks match we have an issue.  If there is only
 450          * one overlapping range which needs to be clipped on both ends
 451          * we wind up having to create up to two new locks, else only one.
 452          *
 453          * count represents the 'cleanup' adjustment needed.  It starts
 454          * negative, is incremented whenever we create a new POSIX lock,
 455          * and decremented whenever we delete an existing one.  At the
 456          * end of the day it had better be <= 0 or we didn't calculate the
 457          * worse case properly here.
 458          */
 459         count = 0;
 460         if (flags & F_POSIX) {
 461                 if (!lf_match(first_match, type, flags) &&
 462                     !lf_match(last_match, type, flags)
 463                 ) {
 464                         if (double_clip)
 465                                 count = -2;
 466                         else
 467                                 count = -1;
 468                 }
 469                 if (count && lf_count_change(owner, -count)) {
 470                         error = ENOLCK;
 471                         goto do_cleanup;
 472                 }
 473         }
 474
 475         /*
 476          * Create and insert the lock represented the requested range.
 477          * Adjust the net POSIX lock count.  We have to move our insertion
 478          * point since brange now represents the first record >= start.
 479          *
 480          * When unlocking, no new lock is inserted but we still clip.
 481          */
 482         if (type != F_UNLCK) {
 483                 brange = new_range1;
 484                 new_range1 = NULL;
 485                 lf_create_range(brange, owner, type, flags, start, end);
 486                 lf_insert(&lock->lf_range, brange, insert_point);
 487                 insert_point = brange;
 488                 if (flags & F_POSIX)
 489                         ++count;
 490         } else {
 491                 brange = NULL;
 492         }
 493
 494         /*
 495          * Handle the double_clip case.  This is the only case where
 496          * we wind up having to add TWO locks.
 497          */
 498         if (double_clip) {
 499                 KKASSERT(first_match == last_match);
 500                 last_match = new_range2;
 501                 new_range2 = NULL;
 502                 lf_create_range(last_match, first_match->lf_owner,
 503                                 first_match->lf_type, first_match->lf_flags,
 504                                 end + 1, first_match->lf_end);
 505                 first_match->lf_end = start - 1;
 506                 first_match->lf_flags &= ~F_NOEND;
 507
 508                 /*
 509                  * Figure out where to insert the right side clip.
 510                  */
 511                 lf_insert(&lock->lf_range, last_match, first_match);
 512                 if (last_match->lf_flags & F_POSIX)
 513                         ++count;
 514         }
 515
 516         /*
 517          * Clip or destroy the locks between first_match and last_match,
 518          * inclusive.  Ignore the primary lock we created (brange).  Note
 519          * that if double-clipped, first_match and last_match will be
 520          * outside our clipping range.  Otherwise first_match and last_match
 521          * will be deleted.
 522          *
 523          * We have already taken care of any double clipping.
 524          *
 525          * insert_point may become invalid as we delete records, do not
 526          * use that pointer any more.
 527          *
 528          * NOTE: brange will be NULL if F_UNLCKing.
 529          */
 530         TAILQ_INIT(&deadlist);
 531         next = first_match;
 532
 533         while ((range = next) != NULL) {
 534                 next = TAILQ_NEXT(range, lf_link);
 535
 536                 /*
 537                  * Ignore elements that we do not own and ignore the
 538                  * primary request range which we just created.
 539                  */
 540                 if (range->lf_owner != owner || range == brange)
 541                         continue;
 542
 543                 /*
 544                  * We may have to wakeup a waiter when downgrading a lock.
 545                  */
 546                 if (type == F_UNLCK)
 547                         wakeup_needed = 1;
 548                 if (type == F_RDLCK && range->lf_type == F_WRLCK)
 549                         wakeup_needed = 1;
 550
 551                 /*
 552                  * Clip left.  This can only occur on first_match.  If
 553                  * we have already double-clipped it there is nothing to do.
 554                  */
 555                 if (range->lf_start < start) {
 556                         KKASSERT(range == first_match);
 557                         if (range->lf_end >= start) {
 558                                 range->lf_end = start - 1;
 559                                 range->lf_flags &= ~F_NOEND;
 560                         }
 561                         if (range == last_match)
 562                                 break;
 563                         continue;
 564                 }
 565
 566                 /*
 567                  * Clip right.  This can only occur on last_match.  If
 568                  * we have already double-clipped it there is nothing to do.
 569                  *
 570                  * Since we are adjusting lf_start, we have to move the
 571                  * record to maintain the sorted list.  Since lf_start is
 572                  * only getting larger we can use the next element as the
 573                  * insert point (we don't have to backtrack).
 574                  */
 575                 if (range->lf_end > end) {
 576                         KKASSERT(range == last_match);
 577                         if (last_match->lf_start <= end) {
 578                                 last_match->lf_start = end + 1;
 579                                 TAILQ_REMOVE(&lock->lf_range, last_match, lf_link);
 580                                 lf_insert(&lock->lf_range, last_match, next);
 581                         }
 582                         /* range == last_match, we are done */
 583                         break;
 584                 }
 585
 586                 /*
 587                  * The record must be entirely enclosed.  Note that the
 588                  * record could be first_match or last_match, and will be
 589                  * deleted.
 590                  */
 591                 KKASSERT(range->lf_start >= start && range->lf_end <= end);
 592                 TAILQ_REMOVE(&lock->lf_range, range, lf_link);
 593                 if (range->lf_flags & F_POSIX)
 594                         --count;
 595                 TAILQ_INSERT_TAIL(&deadlist, range, lf_link);
 596                 if (range == last_match)
 597                         break;
 598         }
 599
 600         /*
 601          * Attempt to merge locks adjacent to brange.  For example, we may
 602          * have had to clip first_match and/or last_match, and they might
 603          * be adjacent.  Or there might simply have been an adjacent lock
 604          * already there.
 605          *
 606          * Don't get fancy, just check adjacent elements in the list if they
 607          * happen to be owned by us.
 608          */
 609         if (brange) {
 610                 range = TAILQ_PREV(brange, lockf_range_list, lf_link);
 611                 if (range &&
 612                     range->lf_owner == owner &&
 613                     range->lf_end == brange->lf_start - 1 &&
 614                     lf_match(range, type, flags)
 615                 ) {
 616                         /*
 617                          * Scrap brange
 618                          */
 619                         range->lf_end = brange->lf_end;
 620                         range->lf_flags |= brange->lf_flags & F_NOEND;
 621                         TAILQ_REMOVE(&lock->lf_range, brange, lf_link);
 622                         if (brange->lf_flags & F_POSIX)
 623                                 --count;
 624                         TAILQ_INSERT_TAIL(&deadlist, brange, lf_link);
 625                         brange = range;
 626                 }
 627                 range = TAILQ_NEXT(brange, lf_link);
 628                 if (range &&
 629                     range->lf_owner == owner &&
 630                     range->lf_start == brange->lf_end + 1 &&
 631                     lf_match(range, type, flags)
 632                 ) {
 633                         /*
 634                          * Scrap range
 635                          */
 636                         brange->lf_end = range->lf_end;
 637                         brange->lf_flags |= brange->lf_flags & F_NOEND;
 638                         TAILQ_REMOVE(&lock->lf_range, range, lf_link);
 639                         if (range->lf_flags & F_POSIX)
 640                                 --count;
 641                         TAILQ_INSERT_TAIL(&deadlist, range, lf_link);
 642                 }
 643         }
 644
 645         /*
 646          * Destroy deleted elements.  We didn't want to do it in the loop
 647          * because the free() might have blocked.
 648          *
 649          * Adjust the count for any posix locks we thought we might create
 650          * but didn't.
 651          */
 652         while ((range = TAILQ_FIRST(&deadlist)) != NULL) {
 653                 TAILQ_REMOVE(&deadlist, range, lf_link);
 654                 lf_destroy_range(range);
 655         }
 656
 657         KKASSERT(count <= 0);
 658         if (count < 0)
 659                 lf_count_change(owner, count);
 660 do_wakeup:
 661         lf_print_lock(lock);
 662         if (wakeup_needed)
 663                 lf_wakeup(lock, start, end);
 664         error = 0;
 665 do_cleanup:
 666         if (new_range1 != NULL)
 667                 lf_destroy_range(new_range1);
 668         if (new_range2 != NULL)
 669                 lf_destroy_range(new_range2);
 670         return(error);
 671 }
 672
 673 /*
 674  * Check whether there is a blocking lock,
 675  * and if so return its process identifier.
 676  */
 677 static int
 678 lf_getlock(struct flock *fl, struct lockf *lock, struct proc *owner,
 679            int type, int flags, off_t start, off_t end)
 680 {
 681         struct lockf_range *range;
 682
 683         TAILQ_FOREACH(range, &lock->lf_range, lf_link)
 684                 if (range->lf_owner != owner &&
 685                     lf_overlap(range, start, end) &&
 686                     (type == F_WRLCK || range->lf_type == F_WRLCK))
 687                         break;
 688         if (range == NULL) {
 689                 fl->l_type = F_UNLCK;
 690                 return(0);
 691         }
 692         fl->l_type = range->lf_type;
 693         fl->l_whence = SEEK_SET;
 694         fl->l_start = range->lf_start;
 695         if (range->lf_flags & F_NOEND)
 696                 fl->l_len = 0;
 697         else
 698                 fl->l_len = range->lf_end - range->lf_start + 1;
 699         if (range->lf_owner != NULL && (range->lf_flags & F_POSIX))
 700                 fl->l_pid = range->lf_owner->p_pid;
 701         else
 702                 fl->l_pid = -1;
 703         return(0);
 704 }
 705
 706 /*
 707  * Wakeup pending lock attempts.
 708  */
 709 static void
 710 lf_wakeup(struct lockf *lock, off_t start, off_t end)
 711 {
 712         struct lockf_range *range, *nrange;
 713         TAILQ_FOREACH_MUTABLE(range, &lock->lf_blocked, lf_link, nrange) {
 714                 if (lf_overlap(range, start, end) == 0)
 715                         continue;
 716                 TAILQ_REMOVE(&lock->lf_blocked, range, lf_link);
 717                 range->lf_flags = 1;
 718                 wakeup(range);
 719                 if (range->lf_start >= start && range->lf_end <= end)
 720                         break;
 721         }
 722 }
 723
 724 /*
 725  * Allocate a range structure and initialize it sufficiently such that
 726  * lf_destroy_range() does not barf.
 727  */
 728 static struct lockf_range *
 729 lf_alloc_range(void)
 730 {
 731         struct lockf_range *range;
 732
 733 #ifdef INVARIANTS
 734         lf_global_counter++;
 735 #endif
 736         range = malloc(sizeof(struct lockf_range), M_LOCKF, M_WAITOK);
 737         range->lf_owner = NULL;
 738         return(range);
 739 }
 740
 741 static void
 742 lf_insert(struct lockf_range_list *list, struct lockf_range *elm,
 743           struct lockf_range *insert_point)
 744 {
 745         while (insert_point && insert_point->lf_start < elm->lf_start)
 746                 insert_point = TAILQ_NEXT(insert_point, lf_link);
 747         if (insert_point != NULL)
 748                 TAILQ_INSERT_BEFORE(insert_point, elm, lf_link);
 749         else
 750                 TAILQ_INSERT_TAIL(list, elm, lf_link);
 751 }
 752
 753 static void
 754 lf_create_range(struct lockf_range *range, struct proc *owner, int type,
 755                 int flags, off_t start, off_t end)
 756 {
 757         KKASSERT(start <= end);
 758         range->lf_type = type;
 759         range->lf_flags = flags;
 760         range->lf_start = start;
 761         range->lf_end = end;
 762         range->lf_owner = owner;
 763
 764         lf_printf("lf_create_range: %lld..%lld\n",
 765                         range->lf_start, range->lf_end);
 766 }
 767
 768 static void
 769 lf_destroy_range(struct lockf_range *range)
 770 {
 771         lf_printf("lf_destroy_range: %lld..%lld\n",
 772                   range->lf_start, range->lf_end);
 773         free(range, M_LOCKF);
 774 #ifdef INVARIANTS
 775         lf_global_counter--;
 776         KKASSERT(lf_global_counter>=0);
 777 #endif
 778 }
 779
 780 #ifdef LOCKF_DEBUG
 781
 782 static void
 783 _lf_printf(const char *ctl, ...)
 784 {
 785         struct proc *p;
 786         __va_list va;
 787
 788         if (lf_print_ranges) {
 789             if ((p = curproc) != NULL)
 790                 printf("pid %d (%s): ", p->p_pid, p->p_comm);
 791         }
 792         __va_start(va, ctl);
 793         vprintf(ctl, va);
 794         __va_end(va);
 795 }
 796
 797 static void
 798 _lf_print_lock(const struct lockf *lock)
 799 {
 800         struct lockf_range *range;
 801
 802         if (lf_print_ranges == 0)
 803                 return;
 804
 805         if (TAILQ_EMPTY(&lock->lf_range)) {
 806                 lf_printf("lockf %p: no ranges locked\n", lock);
 807         } else {
 808                 lf_printf("lockf %p:\n", lock);
 809         }
 810         TAILQ_FOREACH(range, &lock->lf_range, lf_link)
 811                 printf("\t%lld..%lld type %s owned by %d\n",
 812                        range->lf_start, range->lf_end,
 813                        range->lf_type == F_RDLCK ? "shared" : "exclusive",
 814                        range->lf_flags & F_POSIX ? range->lf_owner->p_pid : -1);
 815         if (TAILQ_EMPTY(&lock->lf_blocked))
 816                 printf("no process waiting for range\n");
 817         else
 818                 printf("blocked locks:");
 819         TAILQ_FOREACH(range, &lock->lf_blocked, lf_link)
 820                 printf("\t%lld..%lld type %s waiting on %p\n",
 821                        range->lf_start, range->lf_end,
 822                        range->lf_type == F_RDLCK ? "shared" : "exclusive",
 823                        range);
 824 }
 825 #endif /* LOCKF_DEBUG */