Add parlib/common.h
[akaros.git] / user / parlib / include / spinlock.h
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * Kevin Klues <klueska@cs.berkeley.edu>
4  *
5  * Spinlocks and Spin-PDR locks (preemption detection/recovery)
6  *
7  * This file is part of Parlib.
8  * 
9  * Parlib is free software: you can redistribute it and/or modify
10  * it under the terms of the Lesser GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  * 
14  * Parlib is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * Lesser GNU General Public License for more details.
18  * 
19  * See COPYING.LESSER for details on the GNU Lesser General Public License.
20  * See COPYING for details on the GNU General Public License. */
21
22 #ifndef PARLIB_SPINLOCK_H
23 #define PARLIB_SPINLOCK_H
24
25 #include <parlib/arch/arch.h>
26 #include <parlib/arch/atomic.h>
27
28 __BEGIN_DECLS
29
30 #define SPINLOCK_INITIALIZER {0}
31
32 typedef struct {
33   int lock;
34 } spinlock_t;
35
36 void spinlock_init(spinlock_t *lock);
37 int spinlock_trylock(spinlock_t *lock);
38 void spinlock_lock(spinlock_t *lock);
39 void spinlock_unlock(spinlock_t *lock);
40
41 /* RISCV doesn't support CAS, so til it does, we use the NO_CAS, even if they
42  * didn't ask for it in their config. */
43 #ifdef __riscv__
44 # ifndef CONFIG_SPINPDR_NO_CAS
45 #  define CONFIG_SPINPDR_NO_CAS 1
46 # endif
47 #endif
48
49 /* Two different versions, with and without CAS.  Default is with CAS. */
50 #ifndef CONFIG_SPINPDR_NO_CAS
51
52 # define SPINPDR_UNLOCKED ((uint32_t)-1)
53
54 struct spin_pdr_lock {
55         uint32_t lock;
56 };
57 # define SPINPDR_INITIALIZER {SPINPDR_UNLOCKED}
58
59 #else /* NO_CAS */
60
61 # define SPINPDR_VCOREID_UNKNOWN ((uint32_t)-1)
62
63 struct spin_pdr_lock {
64         /* consider putting these on separate cache lines, if we ever use them */
65         spinlock_t spinlock;
66         uint32_t lockholder;
67 };
68 # define SPINPDR_INITIALIZER {SPINLOCK_INITIALIZER, SPINPDR_VCOREID_UNKNOWN}
69
70 #endif /* CONFIG_SPINPDR_NO_CAS */
71
72 typedef struct spin_pdr_lock spinpdrlock_t;
73
74 void spin_pdr_init(struct spin_pdr_lock *pdr_lock);
75 void spin_pdr_lock(struct spin_pdr_lock *pdr_lock);
76 void spin_pdr_unlock(struct spin_pdr_lock *pdr_lock);
77
78 __END_DECLS
79
80 #endif /* PARLIB_SPINLOCK_H */