xref: /freebsd/sys/contrib/ck/include/ck_spinlock.h (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
1 /*
2  * Copyright 2010-2015 Samy Al Bahra.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef CK_SPINLOCK_H
28 #define CK_SPINLOCK_H
29 
30 #include "spinlock/anderson.h"
31 #include "spinlock/cas.h"
32 #include "spinlock/clh.h"
33 #include "spinlock/dec.h"
34 #include "spinlock/fas.h"
35 #include "spinlock/hclh.h"
36 #include "spinlock/mcs.h"
37 #include "spinlock/ticket.h"
38 
39 /*
40  * On tested x86, x86_64, PPC64 and SPARC64 targets,
41  * ck_spinlock_fas proved to have lowest latency
42  * in fast path testing or negligible degradation
43  * from faster but less robust implementations.
44  */
45 #define CK_SPINLOCK_INITIALIZER CK_SPINLOCK_FAS_INITIALIZER
46 #define ck_spinlock_t		ck_spinlock_fas_t
47 #define ck_spinlock_init(x)	ck_spinlock_fas_init(x)
48 #define ck_spinlock_lock(x)	ck_spinlock_fas_lock(x)
49 #define ck_spinlock_lock_eb(x)	ck_spinlock_fas_lock_eb(x)
50 #define ck_spinlock_unlock(x)	ck_spinlock_fas_unlock(x)
51 #define ck_spinlock_locked(x)	ck_spinlock_fas_locked(x)
52 #define ck_spinlock_trylock(x)	ck_spinlock_fas_trylock(x)
53 
54 CK_ELIDE_PROTOTYPE(ck_spinlock, ck_spinlock_t,
55     ck_spinlock_locked, ck_spinlock_lock,
56     ck_spinlock_locked, ck_spinlock_unlock)
57 
58 CK_ELIDE_TRYLOCK_PROTOTYPE(ck_spinlock, ck_spinlock_t,
59     ck_spinlock_locked, ck_spinlock_trylock)
60 
61 #endif /* CK_SPINLOCK_H */
62