Home | History | Annotate | Line # | Download | only in kern
vfs_lockf.c revision 1.17.2.1
      1  1.17.2.1   nathanw /*	$NetBSD: vfs_lockf.c,v 1.17.2.1 2001/03/05 22:49:48 nathanw Exp $	*/
      2       1.5       cgd 
      3       1.1        ws /*
      4       1.4   mycroft  * Copyright (c) 1982, 1986, 1989, 1993
      5       1.4   mycroft  *	The Regents of the University of California.  All rights reserved.
      6       1.1        ws  *
      7       1.1        ws  * This code is derived from software contributed to Berkeley by
      8       1.1        ws  * Scooter Morris at Genentech Inc.
      9       1.1        ws  *
     10       1.1        ws  * Redistribution and use in source and binary forms, with or without
     11       1.1        ws  * modification, are permitted provided that the following conditions
     12       1.1        ws  * are met:
     13       1.1        ws  * 1. Redistributions of source code must retain the above copyright
     14       1.1        ws  *    notice, this list of conditions and the following disclaimer.
     15       1.1        ws  * 2. Redistributions in binary form must reproduce the above copyright
     16       1.1        ws  *    notice, this list of conditions and the following disclaimer in the
     17       1.1        ws  *    documentation and/or other materials provided with the distribution.
     18       1.1        ws  * 3. All advertising materials mentioning features or use of this software
     19       1.1        ws  *    must display the following acknowledgement:
     20       1.1        ws  *	This product includes software developed by the University of
     21       1.1        ws  *	California, Berkeley and its contributors.
     22       1.1        ws  * 4. Neither the name of the University nor the names of its contributors
     23       1.1        ws  *    may be used to endorse or promote products derived from this software
     24       1.1        ws  *    without specific prior written permission.
     25       1.1        ws  *
     26       1.1        ws  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     27       1.1        ws  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     28       1.1        ws  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     29       1.1        ws  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     30       1.1        ws  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     31       1.1        ws  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     32       1.1        ws  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     33       1.1        ws  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     34       1.1        ws  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     35       1.1        ws  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     36       1.1        ws  * SUCH DAMAGE.
     37       1.1        ws  *
     38      1.12      fvdl  *	@(#)ufs_lockf.c	8.4 (Berkeley) 10/26/94
     39       1.1        ws  */
     40       1.1        ws 
     41       1.1        ws #include <sys/param.h>
     42       1.1        ws #include <sys/systm.h>
     43       1.1        ws #include <sys/kernel.h>
     44       1.1        ws #include <sys/file.h>
     45  1.17.2.1   nathanw #include <sys/lwp.h>
     46       1.1        ws #include <sys/proc.h>
     47       1.1        ws #include <sys/vnode.h>
     48       1.1        ws #include <sys/malloc.h>
     49       1.1        ws #include <sys/fcntl.h>
     50       1.1        ws #include <sys/lockf.h>
     51       1.1        ws 
     52       1.1        ws /*
     53       1.6   mycroft  * This variable controls the maximum number of processes that will
     54       1.6   mycroft  * be checked in doing deadlock detection.
     55       1.6   mycroft  */
     56       1.6   mycroft int maxlockdepth = MAXDEPTH;
     57       1.6   mycroft 
     58       1.6   mycroft #ifdef LOCKF_DEBUG
     59       1.6   mycroft int	lockf_debug = 0;
     60       1.6   mycroft #endif
     61       1.6   mycroft 
     62       1.6   mycroft #define NOLOCKF (struct lockf *)0
     63       1.6   mycroft #define SELF	0x1
     64       1.6   mycroft #define OTHERS	0x2
     65       1.6   mycroft 
     66       1.6   mycroft /*
     67      1.16  sommerfe  * XXX TODO
     68      1.16  sommerfe  * Misc cleanups: "caddr_t id" should be visible in the API as a
     69      1.16  sommerfe  * "struct proc *".
     70      1.16  sommerfe  * (This requires rototilling all VFS's which support advisory locking).
     71      1.16  sommerfe  *
     72      1.16  sommerfe  * Use pools for lock allocation.
     73      1.16  sommerfe  */
     74      1.16  sommerfe 
     75      1.16  sommerfe /*
     76      1.16  sommerfe  * XXXSMP TODO: Using either (a) a global lock, or (b) the vnode's
     77      1.16  sommerfe  * interlock should be sufficient; (b) requires a change to the API
     78      1.16  sommerfe  * because the vnode isn't visible here.
     79      1.16  sommerfe  *
     80      1.16  sommerfe  * If there's a lot of lock contention on a single vnode, locking
     81      1.16  sommerfe  * schemes which allow for more paralleism would be needed.  Given how
     82      1.16  sommerfe  * infrequently byte-range locks are actually used in typical BSD
     83      1.16  sommerfe  * code, a more complex approach probably isn't worth it.
     84      1.16  sommerfe  */
     85      1.16  sommerfe 
     86      1.16  sommerfe /*
     87       1.4   mycroft  * Do an advisory lock operation.
     88       1.1        ws  */
     89       1.4   mycroft int
     90      1.17  jdolecek lf_advlock(ap, head, size)
     91      1.17  jdolecek 	struct vop_advlock_args *ap;
     92       1.1        ws 	struct lockf **head;
     93       1.3       cgd 	off_t size;
     94       1.1        ws {
     95      1.17  jdolecek 	struct flock *fl = ap->a_fl;
     96      1.15  augustss 	struct lockf *lock;
     97       1.1        ws 	off_t start, end;
     98       1.1        ws 	int error;
     99       1.1        ws 
    100       1.1        ws 	/*
    101       1.1        ws 	 * Convert the flock structure into a start and end.
    102       1.1        ws 	 */
    103       1.1        ws 	switch (fl->l_whence) {
    104       1.1        ws 	case SEEK_SET:
    105       1.1        ws 	case SEEK_CUR:
    106       1.1        ws 		/*
    107       1.1        ws 		 * Caller is responsible for adding any necessary offset
    108       1.1        ws 		 * when SEEK_CUR is used.
    109       1.1        ws 		 */
    110       1.1        ws 		start = fl->l_start;
    111       1.1        ws 		break;
    112       1.1        ws 
    113       1.1        ws 	case SEEK_END:
    114       1.1        ws 		start = size + fl->l_start;
    115       1.1        ws 		break;
    116       1.1        ws 
    117       1.1        ws 	default:
    118       1.1        ws 		return (EINVAL);
    119       1.1        ws 	}
    120       1.1        ws 	if (start < 0)
    121       1.1        ws 		return (EINVAL);
    122      1.10    kleink 
    123      1.10    kleink 	/*
    124      1.10    kleink 	 * Avoid the common case of unlocking when inode has no locks.
    125      1.10    kleink 	 */
    126      1.10    kleink 	if (*head == (struct lockf *)0) {
    127      1.17  jdolecek 		if (ap->a_op != F_SETLK) {
    128      1.10    kleink 			fl->l_type = F_UNLCK;
    129      1.10    kleink 			return (0);
    130      1.10    kleink 		}
    131      1.10    kleink 	}
    132      1.10    kleink 
    133       1.1        ws 	if (fl->l_len == 0)
    134       1.1        ws 		end = -1;
    135       1.1        ws 	else
    136       1.1        ws 		end = start + fl->l_len - 1;
    137       1.1        ws 	/*
    138       1.4   mycroft 	 * Create the lockf structure.
    139       1.1        ws 	 */
    140      1.13     perry 	MALLOC(lock, struct lockf *, sizeof(*lock), M_LOCKF, M_WAITOK);
    141       1.1        ws 	lock->lf_start = start;
    142       1.1        ws 	lock->lf_end = end;
    143  1.17.2.1   nathanw 	/* XXX NJWLWP
    144  1.17.2.1   nathanw 	 * I don't want to make the entire VFS universe use LWPs, because
    145  1.17.2.1   nathanw 	 * they don't need them, for the most part. This is an exception,
    146  1.17.2.1   nathanw 	 * and a kluge.
    147  1.17.2.1   nathanw 	 */
    148  1.17.2.1   nathanw 
    149       1.1        ws 	lock->lf_head = head;
    150       1.1        ws 	lock->lf_type = fl->l_type;
    151       1.1        ws 	lock->lf_next = (struct lockf *)0;
    152      1.12      fvdl 	TAILQ_INIT(&lock->lf_blkhd);
    153      1.17  jdolecek 	lock->lf_flags = ap->a_flags;
    154  1.17.2.1   nathanw 	if (lock->lf_flags & F_POSIX) {
    155  1.17.2.1   nathanw 		KASSERT(curproc->l_proc == (struct proc *)ap->a_id);
    156  1.17.2.1   nathanw 		lock->lf_id = (caddr_t) curproc;
    157  1.17.2.1   nathanw 	} else {
    158  1.17.2.1   nathanw 		lock->lf_id = ap->a_id; /* Not a proc at all, but a file * */
    159  1.17.2.1   nathanw 	}
    160  1.17.2.1   nathanw 
    161  1.17.2.1   nathanw 
    162       1.1        ws 	/*
    163       1.1        ws 	 * Do the requested operation.
    164       1.1        ws 	 */
    165      1.17  jdolecek 	switch (ap->a_op) {
    166       1.4   mycroft 
    167       1.1        ws 	case F_SETLK:
    168       1.1        ws 		return (lf_setlock(lock));
    169       1.1        ws 
    170       1.1        ws 	case F_UNLCK:
    171       1.1        ws 		error = lf_clearlock(lock);
    172       1.1        ws 		FREE(lock, M_LOCKF);
    173       1.1        ws 		return (error);
    174       1.1        ws 
    175       1.1        ws 	case F_GETLK:
    176       1.1        ws 		error = lf_getlock(lock, fl);
    177       1.1        ws 		FREE(lock, M_LOCKF);
    178       1.1        ws 		return (error);
    179       1.4   mycroft 
    180       1.1        ws 	default:
    181       1.4   mycroft 		FREE(lock, M_LOCKF);
    182       1.1        ws 		return (EINVAL);
    183       1.1        ws 	}
    184       1.1        ws 	/* NOTREACHED */
    185       1.1        ws }
    186       1.1        ws 
    187       1.1        ws /*
    188       1.1        ws  * Set a byte-range lock.
    189       1.1        ws  */
    190       1.4   mycroft int
    191       1.1        ws lf_setlock(lock)
    192      1.15  augustss 	struct lockf *lock;
    193       1.1        ws {
    194      1.15  augustss 	struct lockf *block;
    195       1.1        ws 	struct lockf **head = lock->lf_head;
    196       1.1        ws 	struct lockf **prev, *overlap, *ltmp;
    197       1.1        ws 	static char lockstr[] = "lockf";
    198       1.1        ws 	int ovcase, priority, needtolink, error;
    199       1.1        ws 
    200       1.1        ws #ifdef LOCKF_DEBUG
    201       1.1        ws 	if (lockf_debug & 1)
    202       1.1        ws 		lf_print("lf_setlock", lock);
    203       1.1        ws #endif /* LOCKF_DEBUG */
    204       1.1        ws 
    205       1.1        ws 	/*
    206       1.1        ws 	 * Set the priority
    207       1.1        ws 	 */
    208       1.1        ws 	priority = PLOCK;
    209       1.1        ws 	if (lock->lf_type == F_WRLCK)
    210       1.1        ws 		priority += 4;
    211       1.1        ws 	priority |= PCATCH;
    212       1.1        ws 	/*
    213       1.1        ws 	 * Scan lock list for this file looking for locks that would block us.
    214       1.1        ws 	 */
    215       1.7  christos 	while ((block = lf_getblock(lock)) != NULL) {
    216       1.1        ws 		/*
    217       1.1        ws 		 * Free the structure and return if nonblocking.
    218       1.1        ws 		 */
    219       1.1        ws 		if ((lock->lf_flags & F_WAIT) == 0) {
    220       1.1        ws 			FREE(lock, M_LOCKF);
    221       1.1        ws 			return (EAGAIN);
    222       1.1        ws 		}
    223       1.1        ws 		/*
    224       1.1        ws 		 * We are blocked. Since flock style locks cover
    225       1.1        ws 		 * the whole file, there is no chance for deadlock.
    226       1.1        ws 		 * For byte-range locks we must check for deadlock.
    227       1.1        ws 		 *
    228       1.1        ws 		 * Deadlock detection is done by looking through the
    229       1.1        ws 		 * wait channels to see if there are any cycles that
    230       1.1        ws 		 * involve us. MAXDEPTH is set just to make sure we
    231      1.16  sommerfe 		 * do not go off into neverneverland.
    232       1.1        ws 		 */
    233       1.1        ws 		if ((lock->lf_flags & F_POSIX) &&
    234       1.1        ws 		    (block->lf_flags & F_POSIX)) {
    235  1.17.2.1   nathanw 			struct lwp *wlwp;
    236      1.15  augustss 			struct lockf *waitblock;
    237       1.1        ws 			int i = 0;
    238       1.1        ws 
    239       1.1        ws 			/* The block is waiting on something */
    240  1.17.2.1   nathanw 			wlwp = (struct lwp *)block->lf_id;
    241  1.17.2.1   nathanw 			while (wlwp->l_wchan &&
    242  1.17.2.1   nathanw 			       (wlwp->l_wmesg == lockstr) &&
    243       1.1        ws 			       (i++ < maxlockdepth)) {
    244  1.17.2.1   nathanw 				waitblock = (struct lockf *)wlwp->l_wchan;
    245       1.1        ws 				/* Get the owner of the blocking lock */
    246       1.1        ws 				waitblock = waitblock->lf_next;
    247       1.1        ws 				if ((waitblock->lf_flags & F_POSIX) == 0)
    248       1.1        ws 					break;
    249  1.17.2.1   nathanw 				wlwp = (struct lwp *)waitblock->lf_id;
    250  1.17.2.1   nathanw 				if (wlwp == (struct lwp *)lock->lf_id) {
    251       1.1        ws 					free(lock, M_LOCKF);
    252       1.1        ws 					return (EDEADLK);
    253       1.1        ws 				}
    254       1.1        ws 			}
    255      1.16  sommerfe 			/*
    256      1.16  sommerfe 			 * If we're still following a dependancy chain
    257      1.16  sommerfe 			 * after maxlockdepth iterations, assume we're in
    258      1.16  sommerfe 			 * a cycle to be safe.
    259      1.16  sommerfe 			 */
    260      1.16  sommerfe 			if (i >= maxlockdepth) {
    261      1.16  sommerfe 				free(lock, M_LOCKF);
    262      1.16  sommerfe 				return (EDEADLK);
    263      1.16  sommerfe 			}
    264       1.1        ws 		}
    265       1.1        ws 		/*
    266       1.1        ws 		 * For flock type locks, we must first remove
    267       1.1        ws 		 * any shared locks that we hold before we sleep
    268       1.1        ws 		 * waiting for an exclusive lock.
    269       1.1        ws 		 */
    270       1.1        ws 		if ((lock->lf_flags & F_FLOCK) &&
    271       1.1        ws 		    lock->lf_type == F_WRLCK) {
    272       1.1        ws 			lock->lf_type = F_UNLCK;
    273       1.1        ws 			(void) lf_clearlock(lock);
    274       1.1        ws 			lock->lf_type = F_WRLCK;
    275       1.1        ws 		}
    276       1.1        ws 		/*
    277       1.1        ws 		 * Add our lock to the blocked list and sleep until we're free.
    278       1.1        ws 		 * Remember who blocked us (for deadlock detection).
    279       1.1        ws 		 */
    280       1.1        ws 		lock->lf_next = block;
    281      1.12      fvdl 		TAILQ_INSERT_TAIL(&block->lf_blkhd, lock, lf_block);
    282       1.1        ws #ifdef LOCKF_DEBUG
    283       1.1        ws 		if (lockf_debug & 1) {
    284       1.1        ws 			lf_print("lf_setlock: blocking on", block);
    285       1.1        ws 			lf_printlist("lf_setlock", block);
    286       1.1        ws 		}
    287       1.1        ws #endif /* LOCKF_DEBUG */
    288       1.7  christos 		error = tsleep((caddr_t)lock, priority, lockstr, 0);
    289      1.16  sommerfe 
    290      1.16  sommerfe 		/*
    291      1.16  sommerfe 		 * We may have been awakened by a signal (in
    292      1.16  sommerfe 		 * which case we must remove ourselves from the
    293      1.16  sommerfe 		 * blocked list) and/or by another process
    294      1.16  sommerfe 		 * releasing a lock (in which case we have already
    295      1.16  sommerfe 		 * been removed from the blocked list and our
    296      1.16  sommerfe 		 * lf_next field set to NOLOCKF).
    297      1.16  sommerfe 		 */
    298      1.16  sommerfe 		if (lock->lf_next != NOLOCKF) {
    299      1.16  sommerfe 			TAILQ_REMOVE(&lock->lf_next->lf_blkhd, lock, lf_block);
    300      1.16  sommerfe 			lock->lf_next = NOLOCKF;
    301      1.16  sommerfe 		}
    302       1.7  christos 		if (error) {
    303       1.4   mycroft 			free(lock, M_LOCKF);
    304       1.4   mycroft 			return (error);
    305       1.1        ws 		}
    306       1.1        ws 	}
    307       1.1        ws 	/*
    308       1.1        ws 	 * No blocks!!  Add the lock.  Note that we will
    309       1.1        ws 	 * downgrade or upgrade any overlapping locks this
    310       1.1        ws 	 * process already owns.
    311       1.1        ws 	 *
    312       1.1        ws 	 * Skip over locks owned by other processes.
    313       1.1        ws 	 * Handle any locks that overlap and are owned by ourselves.
    314       1.1        ws 	 */
    315       1.1        ws 	prev = head;
    316       1.1        ws 	block = *head;
    317       1.1        ws 	needtolink = 1;
    318       1.1        ws 	for (;;) {
    319       1.7  christos 		ovcase = lf_findoverlap(block, lock, SELF, &prev, &overlap);
    320       1.7  christos 		if (ovcase)
    321       1.1        ws 			block = overlap->lf_next;
    322       1.1        ws 		/*
    323       1.1        ws 		 * Six cases:
    324       1.1        ws 		 *	0) no overlap
    325       1.1        ws 		 *	1) overlap == lock
    326       1.1        ws 		 *	2) overlap contains lock
    327       1.1        ws 		 *	3) lock contains overlap
    328       1.1        ws 		 *	4) overlap starts before lock
    329       1.1        ws 		 *	5) overlap ends after lock
    330       1.1        ws 		 */
    331       1.1        ws 		switch (ovcase) {
    332       1.1        ws 		case 0: /* no overlap */
    333       1.1        ws 			if (needtolink) {
    334       1.1        ws 				*prev = lock;
    335       1.1        ws 				lock->lf_next = overlap;
    336       1.1        ws 			}
    337       1.1        ws 			break;
    338       1.1        ws 
    339       1.1        ws 		case 1: /* overlap == lock */
    340       1.1        ws 			/*
    341       1.1        ws 			 * If downgrading lock, others may be
    342       1.1        ws 			 * able to acquire it.
    343       1.1        ws 			 */
    344       1.1        ws 			if (lock->lf_type == F_RDLCK &&
    345       1.1        ws 			    overlap->lf_type == F_WRLCK)
    346       1.1        ws 				lf_wakelock(overlap);
    347       1.1        ws 			overlap->lf_type = lock->lf_type;
    348       1.1        ws 			FREE(lock, M_LOCKF);
    349       1.1        ws 			lock = overlap; /* for debug output below */
    350       1.1        ws 			break;
    351       1.1        ws 
    352       1.1        ws 		case 2: /* overlap contains lock */
    353       1.1        ws 			/*
    354       1.1        ws 			 * Check for common starting point and different types.
    355       1.1        ws 			 */
    356       1.1        ws 			if (overlap->lf_type == lock->lf_type) {
    357       1.1        ws 				free(lock, M_LOCKF);
    358       1.1        ws 				lock = overlap; /* for debug output below */
    359       1.1        ws 				break;
    360       1.1        ws 			}
    361       1.1        ws 			if (overlap->lf_start == lock->lf_start) {
    362       1.1        ws 				*prev = lock;
    363       1.1        ws 				lock->lf_next = overlap;
    364       1.1        ws 				overlap->lf_start = lock->lf_end + 1;
    365       1.1        ws 			} else
    366       1.1        ws 				lf_split(overlap, lock);
    367       1.1        ws 			lf_wakelock(overlap);
    368       1.1        ws 			break;
    369       1.1        ws 
    370       1.1        ws 		case 3: /* lock contains overlap */
    371       1.1        ws 			/*
    372       1.1        ws 			 * If downgrading lock, others may be able to
    373       1.1        ws 			 * acquire it, otherwise take the list.
    374       1.1        ws 			 */
    375       1.1        ws 			if (lock->lf_type == F_RDLCK &&
    376       1.1        ws 			    overlap->lf_type == F_WRLCK) {
    377       1.1        ws 				lf_wakelock(overlap);
    378       1.1        ws 			} else {
    379      1.12      fvdl 				while ((ltmp = overlap->lf_blkhd.tqh_first)) {
    380      1.16  sommerfe 					KASSERT(ltmp->lf_next == overlap);
    381      1.12      fvdl 					TAILQ_REMOVE(&overlap->lf_blkhd, ltmp,
    382      1.12      fvdl 					    lf_block);
    383      1.16  sommerfe 					ltmp->lf_next = lock;
    384      1.12      fvdl 					TAILQ_INSERT_TAIL(&lock->lf_blkhd,
    385      1.12      fvdl 					    ltmp, lf_block);
    386      1.12      fvdl 				}
    387       1.1        ws 			}
    388       1.1        ws 			/*
    389       1.1        ws 			 * Add the new lock if necessary and delete the overlap.
    390       1.1        ws 			 */
    391       1.1        ws 			if (needtolink) {
    392       1.1        ws 				*prev = lock;
    393       1.1        ws 				lock->lf_next = overlap->lf_next;
    394       1.1        ws 				prev = &lock->lf_next;
    395       1.1        ws 				needtolink = 0;
    396       1.1        ws 			} else
    397       1.1        ws 				*prev = overlap->lf_next;
    398       1.1        ws 			free(overlap, M_LOCKF);
    399       1.1        ws 			continue;
    400       1.1        ws 
    401       1.1        ws 		case 4: /* overlap starts before lock */
    402       1.1        ws 			/*
    403       1.1        ws 			 * Add lock after overlap on the list.
    404       1.1        ws 			 */
    405       1.1        ws 			lock->lf_next = overlap->lf_next;
    406       1.1        ws 			overlap->lf_next = lock;
    407       1.1        ws 			overlap->lf_end = lock->lf_start - 1;
    408       1.1        ws 			prev = &lock->lf_next;
    409       1.1        ws 			lf_wakelock(overlap);
    410       1.1        ws 			needtolink = 0;
    411       1.1        ws 			continue;
    412       1.1        ws 
    413       1.1        ws 		case 5: /* overlap ends after lock */
    414       1.1        ws 			/*
    415       1.1        ws 			 * Add the new lock before overlap.
    416       1.1        ws 			 */
    417       1.1        ws 			if (needtolink) {
    418       1.1        ws 				*prev = lock;
    419       1.1        ws 				lock->lf_next = overlap;
    420       1.1        ws 			}
    421       1.1        ws 			overlap->lf_start = lock->lf_end + 1;
    422       1.1        ws 			lf_wakelock(overlap);
    423       1.1        ws 			break;
    424       1.1        ws 		}
    425       1.1        ws 		break;
    426       1.1        ws 	}
    427       1.1        ws #ifdef LOCKF_DEBUG
    428       1.1        ws 	if (lockf_debug & 1) {
    429       1.1        ws 		lf_print("lf_setlock: got the lock", lock);
    430       1.1        ws 		lf_printlist("lf_setlock", lock);
    431       1.1        ws 	}
    432       1.1        ws #endif /* LOCKF_DEBUG */
    433       1.1        ws 	return (0);
    434       1.1        ws }
    435       1.1        ws 
    436       1.1        ws /*
    437       1.1        ws  * Remove a byte-range lock on an inode.
    438       1.1        ws  *
    439       1.1        ws  * Generally, find the lock (or an overlap to that lock)
    440       1.1        ws  * and remove it (or shrink it), then wakeup anyone we can.
    441       1.1        ws  */
    442       1.4   mycroft int
    443       1.1        ws lf_clearlock(unlock)
    444      1.15  augustss 	struct lockf *unlock;
    445       1.1        ws {
    446       1.1        ws 	struct lockf **head = unlock->lf_head;
    447      1.15  augustss 	struct lockf *lf = *head;
    448       1.1        ws 	struct lockf *overlap, **prev;
    449       1.1        ws 	int ovcase;
    450       1.1        ws 
    451       1.1        ws 	if (lf == NOLOCKF)
    452       1.1        ws 		return (0);
    453       1.1        ws #ifdef LOCKF_DEBUG
    454       1.1        ws 	if (unlock->lf_type != F_UNLCK)
    455       1.1        ws 		panic("lf_clearlock: bad type");
    456       1.1        ws 	if (lockf_debug & 1)
    457       1.1        ws 		lf_print("lf_clearlock", unlock);
    458       1.1        ws #endif /* LOCKF_DEBUG */
    459       1.1        ws 	prev = head;
    460       1.7  christos 	while ((ovcase = lf_findoverlap(lf, unlock, SELF,
    461       1.7  christos 					&prev, &overlap)) != 0) {
    462       1.1        ws 		/*
    463       1.1        ws 		 * Wakeup the list of locks to be retried.
    464       1.1        ws 		 */
    465       1.1        ws 		lf_wakelock(overlap);
    466       1.1        ws 
    467       1.1        ws 		switch (ovcase) {
    468       1.1        ws 
    469       1.1        ws 		case 1: /* overlap == lock */
    470       1.1        ws 			*prev = overlap->lf_next;
    471       1.1        ws 			FREE(overlap, M_LOCKF);
    472       1.1        ws 			break;
    473       1.1        ws 
    474       1.1        ws 		case 2: /* overlap contains lock: split it */
    475       1.1        ws 			if (overlap->lf_start == unlock->lf_start) {
    476       1.1        ws 				overlap->lf_start = unlock->lf_end + 1;
    477       1.1        ws 				break;
    478       1.1        ws 			}
    479       1.1        ws 			lf_split(overlap, unlock);
    480       1.1        ws 			overlap->lf_next = unlock->lf_next;
    481       1.1        ws 			break;
    482       1.1        ws 
    483       1.1        ws 		case 3: /* lock contains overlap */
    484       1.1        ws 			*prev = overlap->lf_next;
    485       1.1        ws 			lf = overlap->lf_next;
    486       1.1        ws 			free(overlap, M_LOCKF);
    487       1.1        ws 			continue;
    488       1.1        ws 
    489       1.1        ws 		case 4: /* overlap starts before lock */
    490       1.1        ws 			overlap->lf_end = unlock->lf_start - 1;
    491       1.1        ws 			prev = &overlap->lf_next;
    492       1.1        ws 			lf = overlap->lf_next;
    493       1.1        ws 			continue;
    494       1.1        ws 
    495       1.1        ws 		case 5: /* overlap ends after lock */
    496       1.1        ws 			overlap->lf_start = unlock->lf_end + 1;
    497       1.1        ws 			break;
    498       1.1        ws 		}
    499       1.1        ws 		break;
    500       1.1        ws 	}
    501       1.1        ws #ifdef LOCKF_DEBUG
    502       1.1        ws 	if (lockf_debug & 1)
    503       1.1        ws 		lf_printlist("lf_clearlock", unlock);
    504       1.1        ws #endif /* LOCKF_DEBUG */
    505       1.1        ws 	return (0);
    506       1.1        ws }
    507       1.1        ws 
    508       1.1        ws /*
    509       1.1        ws  * Check whether there is a blocking lock,
    510       1.1        ws  * and if so return its process identifier.
    511       1.1        ws  */
    512       1.4   mycroft int
    513       1.1        ws lf_getlock(lock, fl)
    514      1.15  augustss 	struct lockf *lock;
    515      1.15  augustss 	struct flock *fl;
    516       1.1        ws {
    517      1.15  augustss 	struct lockf *block;
    518       1.1        ws 
    519       1.1        ws #ifdef LOCKF_DEBUG
    520       1.1        ws 	if (lockf_debug & 1)
    521       1.1        ws 		lf_print("lf_getlock", lock);
    522       1.1        ws #endif /* LOCKF_DEBUG */
    523       1.1        ws 
    524       1.7  christos 	if ((block = lf_getblock(lock)) != NULL) {
    525       1.1        ws 		fl->l_type = block->lf_type;
    526       1.1        ws 		fl->l_whence = SEEK_SET;
    527       1.1        ws 		fl->l_start = block->lf_start;
    528       1.1        ws 		if (block->lf_end == -1)
    529       1.1        ws 			fl->l_len = 0;
    530       1.1        ws 		else
    531       1.1        ws 			fl->l_len = block->lf_end - block->lf_start + 1;
    532       1.1        ws 		if (block->lf_flags & F_POSIX)
    533  1.17.2.1   nathanw 			fl->l_pid = ((struct lwp *)(block->lf_id))->l_proc->p_pid;
    534       1.1        ws 		else
    535       1.1        ws 			fl->l_pid = -1;
    536       1.1        ws 	} else {
    537       1.1        ws 		fl->l_type = F_UNLCK;
    538       1.1        ws 	}
    539       1.1        ws 	return (0);
    540       1.1        ws }
    541       1.1        ws 
    542       1.1        ws /*
    543       1.1        ws  * Walk the list of locks for an inode and
    544       1.1        ws  * return the first blocking lock.
    545       1.1        ws  */
    546       1.1        ws struct lockf *
    547       1.1        ws lf_getblock(lock)
    548      1.15  augustss 	struct lockf *lock;
    549       1.1        ws {
    550       1.1        ws 	struct lockf **prev, *overlap, *lf = *(lock->lf_head);
    551       1.1        ws 	int ovcase;
    552       1.1        ws 
    553       1.1        ws 	prev = lock->lf_head;
    554       1.7  christos 	while ((ovcase = lf_findoverlap(lf, lock, OTHERS,
    555       1.7  christos 					&prev, &overlap)) != 0) {
    556       1.1        ws 		/*
    557       1.1        ws 		 * We've found an overlap, see if it blocks us
    558       1.1        ws 		 */
    559       1.1        ws 		if ((lock->lf_type == F_WRLCK || overlap->lf_type == F_WRLCK))
    560       1.1        ws 			return (overlap);
    561       1.1        ws 		/*
    562       1.1        ws 		 * Nope, point to the next one on the list and
    563       1.1        ws 		 * see if it blocks us
    564       1.1        ws 		 */
    565       1.1        ws 		lf = overlap->lf_next;
    566       1.1        ws 	}
    567       1.1        ws 	return (NOLOCKF);
    568       1.1        ws }
    569       1.1        ws 
    570       1.1        ws /*
    571       1.1        ws  * Walk the list of locks for an inode to
    572       1.1        ws  * find an overlapping lock (if any).
    573       1.1        ws  *
    574       1.1        ws  * NOTE: this returns only the FIRST overlapping lock.  There
    575       1.1        ws  *	 may be more than one.
    576       1.1        ws  */
    577       1.4   mycroft int
    578       1.1        ws lf_findoverlap(lf, lock, type, prev, overlap)
    579      1.15  augustss 	struct lockf *lf;
    580       1.1        ws 	struct lockf *lock;
    581       1.1        ws 	int type;
    582       1.1        ws 	struct lockf ***prev;
    583       1.1        ws 	struct lockf **overlap;
    584       1.1        ws {
    585       1.1        ws 	off_t start, end;
    586       1.1        ws 
    587       1.1        ws 	*overlap = lf;
    588       1.1        ws 	if (lf == NOLOCKF)
    589       1.1        ws 		return (0);
    590       1.1        ws #ifdef LOCKF_DEBUG
    591       1.1        ws 	if (lockf_debug & 2)
    592       1.1        ws 		lf_print("lf_findoverlap: looking for overlap in", lock);
    593       1.1        ws #endif /* LOCKF_DEBUG */
    594       1.1        ws 	start = lock->lf_start;
    595       1.1        ws 	end = lock->lf_end;
    596       1.1        ws 	while (lf != NOLOCKF) {
    597       1.1        ws 		if (((type & SELF) && lf->lf_id != lock->lf_id) ||
    598       1.1        ws 		    ((type & OTHERS) && lf->lf_id == lock->lf_id)) {
    599       1.1        ws 			*prev = &lf->lf_next;
    600       1.1        ws 			*overlap = lf = lf->lf_next;
    601       1.1        ws 			continue;
    602       1.1        ws 		}
    603       1.1        ws #ifdef LOCKF_DEBUG
    604       1.1        ws 		if (lockf_debug & 2)
    605       1.1        ws 			lf_print("\tchecking", lf);
    606       1.1        ws #endif /* LOCKF_DEBUG */
    607       1.1        ws 		/*
    608       1.1        ws 		 * OK, check for overlap
    609       1.1        ws 		 *
    610       1.1        ws 		 * Six cases:
    611       1.1        ws 		 *	0) no overlap
    612       1.1        ws 		 *	1) overlap == lock
    613       1.1        ws 		 *	2) overlap contains lock
    614       1.1        ws 		 *	3) lock contains overlap
    615       1.1        ws 		 *	4) overlap starts before lock
    616       1.1        ws 		 *	5) overlap ends after lock
    617       1.1        ws 		 */
    618       1.1        ws 		if ((lf->lf_end != -1 && start > lf->lf_end) ||
    619       1.1        ws 		    (end != -1 && lf->lf_start > end)) {
    620       1.1        ws 			/* Case 0 */
    621       1.1        ws #ifdef LOCKF_DEBUG
    622       1.1        ws 			if (lockf_debug & 2)
    623       1.9  christos 				printf("no overlap\n");
    624       1.1        ws #endif /* LOCKF_DEBUG */
    625       1.1        ws 			if ((type & SELF) && end != -1 && lf->lf_start > end)
    626       1.1        ws 				return (0);
    627       1.1        ws 			*prev = &lf->lf_next;
    628       1.1        ws 			*overlap = lf = lf->lf_next;
    629       1.1        ws 			continue;
    630       1.1        ws 		}
    631       1.1        ws 		if ((lf->lf_start == start) && (lf->lf_end == end)) {
    632       1.1        ws 			/* Case 1 */
    633       1.1        ws #ifdef LOCKF_DEBUG
    634       1.1        ws 			if (lockf_debug & 2)
    635       1.9  christos 				printf("overlap == lock\n");
    636       1.1        ws #endif /* LOCKF_DEBUG */
    637       1.1        ws 			return (1);
    638       1.1        ws 		}
    639       1.1        ws 		if ((lf->lf_start <= start) &&
    640       1.1        ws 		    (end != -1) &&
    641       1.1        ws 		    ((lf->lf_end >= end) || (lf->lf_end == -1))) {
    642       1.1        ws 			/* Case 2 */
    643       1.1        ws #ifdef LOCKF_DEBUG
    644       1.1        ws 			if (lockf_debug & 2)
    645       1.9  christos 				printf("overlap contains lock\n");
    646       1.1        ws #endif /* LOCKF_DEBUG */
    647       1.1        ws 			return (2);
    648       1.1        ws 		}
    649       1.1        ws 		if (start <= lf->lf_start &&
    650       1.4   mycroft 		           (end == -1 ||
    651       1.1        ws 			   (lf->lf_end != -1 && end >= lf->lf_end))) {
    652       1.1        ws 			/* Case 3 */
    653       1.1        ws #ifdef LOCKF_DEBUG
    654       1.1        ws 			if (lockf_debug & 2)
    655       1.9  christos 				printf("lock contains overlap\n");
    656       1.1        ws #endif /* LOCKF_DEBUG */
    657       1.1        ws 			return (3);
    658       1.1        ws 		}
    659       1.1        ws 		if ((lf->lf_start < start) &&
    660       1.1        ws 			((lf->lf_end >= start) || (lf->lf_end == -1))) {
    661       1.1        ws 			/* Case 4 */
    662       1.1        ws #ifdef LOCKF_DEBUG
    663       1.1        ws 			if (lockf_debug & 2)
    664       1.9  christos 				printf("overlap starts before lock\n");
    665       1.1        ws #endif /* LOCKF_DEBUG */
    666       1.1        ws 			return (4);
    667       1.1        ws 		}
    668       1.1        ws 		if ((lf->lf_start > start) &&
    669       1.1        ws 			(end != -1) &&
    670       1.1        ws 			((lf->lf_end > end) || (lf->lf_end == -1))) {
    671       1.1        ws 			/* Case 5 */
    672       1.1        ws #ifdef LOCKF_DEBUG
    673       1.1        ws 			if (lockf_debug & 2)
    674       1.9  christos 				printf("overlap ends after lock\n");
    675       1.1        ws #endif /* LOCKF_DEBUG */
    676       1.1        ws 			return (5);
    677       1.1        ws 		}
    678       1.1        ws 		panic("lf_findoverlap: default");
    679       1.1        ws 	}
    680       1.1        ws 	return (0);
    681       1.1        ws }
    682       1.1        ws 
    683       1.1        ws /*
    684       1.1        ws  * Split a lock and a contained region into
    685       1.1        ws  * two or three locks as necessary.
    686       1.1        ws  */
    687       1.2       cgd void
    688       1.1        ws lf_split(lock1, lock2)
    689      1.15  augustss 	struct lockf *lock1;
    690      1.15  augustss 	struct lockf *lock2;
    691       1.1        ws {
    692      1.15  augustss 	struct lockf *splitlock;
    693       1.1        ws 
    694       1.1        ws #ifdef LOCKF_DEBUG
    695       1.1        ws 	if (lockf_debug & 2) {
    696       1.1        ws 		lf_print("lf_split", lock1);
    697       1.1        ws 		lf_print("splitting from", lock2);
    698       1.1        ws 	}
    699       1.1        ws #endif /* LOCKF_DEBUG */
    700       1.1        ws 	/*
    701       1.1        ws 	 * Check to see if spliting into only two pieces.
    702       1.1        ws 	 */
    703       1.1        ws 	if (lock1->lf_start == lock2->lf_start) {
    704       1.1        ws 		lock1->lf_start = lock2->lf_end + 1;
    705       1.1        ws 		lock2->lf_next = lock1;
    706       1.1        ws 		return;
    707       1.1        ws 	}
    708       1.1        ws 	if (lock1->lf_end == lock2->lf_end) {
    709       1.1        ws 		lock1->lf_end = lock2->lf_start - 1;
    710       1.1        ws 		lock2->lf_next = lock1->lf_next;
    711       1.1        ws 		lock1->lf_next = lock2;
    712       1.1        ws 		return;
    713       1.1        ws 	}
    714       1.1        ws 	/*
    715       1.1        ws 	 * Make a new lock consisting of the last part of
    716       1.1        ws 	 * the encompassing lock
    717       1.1        ws 	 */
    718      1.13     perry 	MALLOC(splitlock, struct lockf *, sizeof(*splitlock), M_LOCKF, M_WAITOK);
    719      1.14     perry 	memcpy((caddr_t)splitlock, (caddr_t)lock1, sizeof(*splitlock));
    720       1.1        ws 	splitlock->lf_start = lock2->lf_end + 1;
    721      1.12      fvdl 	TAILQ_INIT(&splitlock->lf_blkhd);
    722       1.1        ws 	lock1->lf_end = lock2->lf_start - 1;
    723       1.1        ws 	/*
    724       1.1        ws 	 * OK, now link it in
    725       1.1        ws 	 */
    726       1.1        ws 	splitlock->lf_next = lock1->lf_next;
    727       1.1        ws 	lock2->lf_next = splitlock;
    728       1.1        ws 	lock1->lf_next = lock2;
    729       1.1        ws }
    730       1.1        ws 
    731       1.1        ws /*
    732       1.1        ws  * Wakeup a blocklist
    733       1.1        ws  */
    734       1.2       cgd void
    735       1.1        ws lf_wakelock(listhead)
    736       1.1        ws 	struct lockf *listhead;
    737       1.1        ws {
    738      1.15  augustss 	struct lockf *wakelock;
    739       1.1        ws 
    740      1.12      fvdl 	while ((wakelock = listhead->lf_blkhd.tqh_first)) {
    741      1.16  sommerfe 		KASSERT(wakelock->lf_next == listhead);
    742      1.12      fvdl 		TAILQ_REMOVE(&listhead->lf_blkhd, wakelock, lf_block);
    743       1.1        ws 		wakelock->lf_next = NOLOCKF;
    744       1.1        ws #ifdef LOCKF_DEBUG
    745       1.1        ws 		if (lockf_debug & 2)
    746       1.1        ws 			lf_print("lf_wakelock: awakening", wakelock);
    747      1.12      fvdl #endif
    748       1.1        ws 		wakeup((caddr_t)wakelock);
    749       1.1        ws 	}
    750       1.1        ws }
    751       1.1        ws 
    752       1.1        ws #ifdef LOCKF_DEBUG
    753       1.1        ws /*
    754       1.1        ws  * Print out a lock.
    755       1.1        ws  */
    756       1.4   mycroft void
    757       1.1        ws lf_print(tag, lock)
    758       1.1        ws 	char *tag;
    759      1.15  augustss 	struct lockf *lock;
    760       1.1        ws {
    761       1.1        ws 
    762       1.9  christos 	printf("%s: lock %p for ", tag, lock);
    763       1.1        ws 	if (lock->lf_flags & F_POSIX)
    764       1.9  christos 		printf("proc %d", ((struct proc *)(lock->lf_id))->p_pid);
    765       1.1        ws 	else
    766      1.11       jtk 		printf("id 0x%p", lock->lf_id);
    767      1.11       jtk 	printf(" %s, start %qx, end %qx",
    768       1.1        ws 		lock->lf_type == F_RDLCK ? "shared" :
    769       1.1        ws 		lock->lf_type == F_WRLCK ? "exclusive" :
    770       1.1        ws 		lock->lf_type == F_UNLCK ? "unlock" :
    771       1.1        ws 		"unknown", lock->lf_start, lock->lf_end);
    772      1.12      fvdl 	if (lock->lf_blkhd.tqh_first)
    773      1.12      fvdl 		printf(" block %p\n", lock->lf_blkhd.tqh_first);
    774       1.1        ws 	else
    775       1.9  christos 		printf("\n");
    776       1.1        ws }
    777       1.1        ws 
    778       1.4   mycroft void
    779       1.1        ws lf_printlist(tag, lock)
    780       1.1        ws 	char *tag;
    781       1.1        ws 	struct lockf *lock;
    782       1.1        ws {
    783      1.15  augustss 	struct lockf *lf, *blk;
    784       1.1        ws 
    785      1.11       jtk 	printf("%s: Lock list:\n", tag);
    786      1.12      fvdl 	for (lf = *lock->lf_head; lf; lf = lf->lf_next) {
    787       1.9  christos 		printf("\tlock %p for ", lf);
    788       1.1        ws 		if (lf->lf_flags & F_POSIX)
    789       1.9  christos 			printf("proc %d", ((struct proc *)(lf->lf_id))->p_pid);
    790       1.1        ws 		else
    791      1.11       jtk 			printf("id 0x%p", lf->lf_id);
    792      1.11       jtk 		printf(", %s, start %qx, end %qx",
    793       1.1        ws 			lf->lf_type == F_RDLCK ? "shared" :
    794       1.1        ws 			lf->lf_type == F_WRLCK ? "exclusive" :
    795       1.1        ws 			lf->lf_type == F_UNLCK ? "unlock" :
    796       1.1        ws 			"unknown", lf->lf_start, lf->lf_end);
    797      1.12      fvdl 		for (blk = lf->lf_blkhd.tqh_first; blk;
    798      1.12      fvdl 		     blk = blk->lf_block.tqe_next) {
    799      1.12      fvdl 			if (blk->lf_flags & F_POSIX)
    800      1.12      fvdl 				printf("proc %d",
    801      1.12      fvdl 				    ((struct proc *)(blk->lf_id))->p_pid);
    802      1.12      fvdl 			else
    803      1.12      fvdl 				printf("id 0x%p", blk->lf_id);
    804      1.12      fvdl 			printf(", %s, start %qx, end %qx",
    805      1.12      fvdl 				blk->lf_type == F_RDLCK ? "shared" :
    806      1.12      fvdl 				blk->lf_type == F_WRLCK ? "exclusive" :
    807      1.12      fvdl 				blk->lf_type == F_UNLCK ? "unlock" :
    808      1.12      fvdl 				"unknown", blk->lf_start, blk->lf_end);
    809      1.12      fvdl 			if (blk->lf_blkhd.tqh_first)
    810      1.12      fvdl 				 panic("lf_printlist: bad list");
    811      1.12      fvdl 		}
    812      1.12      fvdl 		printf("\n");
    813       1.1        ws 	}
    814       1.1        ws }
    815       1.1        ws #endif /* LOCKF_DEBUG */
    816