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