xref: /dflybsd-src/lib/libc/include/spinlock.h (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1*86d7f5d3SJohn Marino /*
2*86d7f5d3SJohn Marino  * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>.
3*86d7f5d3SJohn Marino  * All rights reserved.
4*86d7f5d3SJohn Marino  *
5*86d7f5d3SJohn Marino  * Redistribution and use in source and binary forms, with or without
6*86d7f5d3SJohn Marino  * modification, are permitted provided that the following conditions
7*86d7f5d3SJohn Marino  * are met:
8*86d7f5d3SJohn Marino  * 1. Redistributions of source code must retain the above copyright
9*86d7f5d3SJohn Marino  *    notice, this list of conditions and the following disclaimer.
10*86d7f5d3SJohn Marino  * 2. Redistributions in binary form must reproduce the above copyright
11*86d7f5d3SJohn Marino  *    notice, this list of conditions and the following disclaimer in the
12*86d7f5d3SJohn Marino  *    documentation and/or other materials provided with the distribution.
13*86d7f5d3SJohn Marino  * 3. All advertising materials mentioning features or use of this software
14*86d7f5d3SJohn Marino  *    must display the following acknowledgement:
15*86d7f5d3SJohn Marino  *	This product includes software developed by John Birrell.
16*86d7f5d3SJohn Marino  * 4. Neither the name of the author nor the names of any co-contributors
17*86d7f5d3SJohn Marino  *    may be used to endorse or promote products derived from this software
18*86d7f5d3SJohn Marino  *    without specific prior written permission.
19*86d7f5d3SJohn Marino  *
20*86d7f5d3SJohn Marino  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
21*86d7f5d3SJohn Marino  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22*86d7f5d3SJohn Marino  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23*86d7f5d3SJohn Marino  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24*86d7f5d3SJohn Marino  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25*86d7f5d3SJohn Marino  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26*86d7f5d3SJohn Marino  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27*86d7f5d3SJohn Marino  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28*86d7f5d3SJohn Marino  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29*86d7f5d3SJohn Marino  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30*86d7f5d3SJohn Marino  * SUCH DAMAGE.
31*86d7f5d3SJohn Marino  *
32*86d7f5d3SJohn Marino  * $FreeBSD: src/lib/libc/include/spinlock.h,v 1.4 1999/08/27 23:59:48 peter Exp $
33*86d7f5d3SJohn Marino  * $DragonFly: src/lib/libc/include/spinlock.h,v 1.4 2005/01/31 22:29:29 dillon Exp $
34*86d7f5d3SJohn Marino  *
35*86d7f5d3SJohn Marino  * Lock definitions used in both libc and libpthread.
36*86d7f5d3SJohn Marino  *
37*86d7f5d3SJohn Marino  */
38*86d7f5d3SJohn Marino 
39*86d7f5d3SJohn Marino #ifndef _SPINLOCK_H_
40*86d7f5d3SJohn Marino #define _SPINLOCK_H_
41*86d7f5d3SJohn Marino #include <sys/cdefs.h>
42*86d7f5d3SJohn Marino #include <sys/types.h>
43*86d7f5d3SJohn Marino 
44*86d7f5d3SJohn Marino /*
45*86d7f5d3SJohn Marino  * Lock structure with room for debugging information.
46*86d7f5d3SJohn Marino  */
47*86d7f5d3SJohn Marino typedef struct {
48*86d7f5d3SJohn Marino 	volatile long	access_lock;
49*86d7f5d3SJohn Marino 	volatile long	lock_owner;
50*86d7f5d3SJohn Marino 	volatile char	*fname;
51*86d7f5d3SJohn Marino 	volatile int	lineno;
52*86d7f5d3SJohn Marino } spinlock_t;
53*86d7f5d3SJohn Marino 
54*86d7f5d3SJohn Marino #define	_SPINLOCK_INITIALIZER	{ 0, 0, 0, 0 }
55*86d7f5d3SJohn Marino 
56*86d7f5d3SJohn Marino #define _SPINUNLOCK(_lck)	_spinunlock(_lck)
57*86d7f5d3SJohn Marino #ifdef	_LOCK_DEBUG
58*86d7f5d3SJohn Marino #define	_SPINLOCK(_lck)		_spinlock_debug(_lck, __FILE__, __LINE__)
59*86d7f5d3SJohn Marino #else
60*86d7f5d3SJohn Marino #define	_SPINLOCK(_lck)		_spinlock(_lck)
61*86d7f5d3SJohn Marino #endif
62*86d7f5d3SJohn Marino #define _SPINTRYLOCK(_lck)	_spintrylock(_lck)
63*86d7f5d3SJohn Marino 
64*86d7f5d3SJohn Marino /*
65*86d7f5d3SJohn Marino  * Thread function prototype definitions:
66*86d7f5d3SJohn Marino  */
67*86d7f5d3SJohn Marino __BEGIN_DECLS
68*86d7f5d3SJohn Marino long	_atomic_lock (volatile long *);
69*86d7f5d3SJohn Marino void	_spinlock (spinlock_t *);
70*86d7f5d3SJohn Marino int	_spintrylock (spinlock_t *);
71*86d7f5d3SJohn Marino void	_spinlock_debug (spinlock_t *, char *, int);
72*86d7f5d3SJohn Marino void	_spinunlock (spinlock_t *);
73*86d7f5d3SJohn Marino __END_DECLS
74*86d7f5d3SJohn Marino 
75*86d7f5d3SJohn Marino #endif /* _SPINLOCK_H_ */
76