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