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