38e9a6b5c951db561abc1ee6b811bf8eda0531b6
[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 SPINLOCK_H
23 #define SPINLOCK_H
24
25 #include <arch/arch.h>
26 #include <arch/atomic.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #define SPINLOCK_INITIALIZER {0}
33
34 typedef struct {
35   int lock;
36 } spinlock_t;
37
38 void spinlock_init(spinlock_t *lock);
39 int spinlock_trylock(spinlock_t *lock);
40 void spinlock_lock(spinlock_t *lock);
41 void spinlock_unlock(spinlock_t *lock);
42
43 /* RISCV doesn't support CAS, so til it does, we use the NO_CAS, even if they
44  * didn't ask for it in their config. */
45 #ifdef __riscv__
46 # ifndef CONFIG_SPINPDR_NO_CAS
47 #  define CONFIG_SPINPDR_NO_CAS 1
48 # endif
49 #endif
50
51 /* Two different versions, with and without CAS.  Default is with CAS. */
52 #ifndef CONFIG_SPINPDR_NO_CAS
53
54 # define SPINPDR_UNLOCKED ((uint32_t)-1)
55
56 struct spin_pdr_lock {
57         uint32_t lock;
58 };
59 # define SPINPDR_INITIALIZER {SPINPDR_UNLOCKED}
60
61 #else /* NO_CAS */
62
63 # define SPINPDR_VCOREID_UNKNOWN ((uint32_t)-1)
64
65 struct spin_pdr_lock {
66         /* consider putting these on separate cache lines, if we ever use them */
67         spinlock_t spinlock;
68         uint32_t lockholder;
69 };
70 # define SPINPDR_INITIALIZER {SPINLOCK_INITIALIZER, SPINPDR_VCOREID_UNKNOWN}
71
72 #endif /* CONFIG_SPINPDR_NO_CAS */
73
74 typedef struct spin_pdr_lock spinpdrlock_t;
75
76 void spin_pdr_init(struct spin_pdr_lock *pdr_lock);
77 void spin_pdr_lock(struct spin_pdr_lock *pdr_lock);
78 void spin_pdr_unlock(struct spin_pdr_lock *pdr_lock);
79
80 #ifdef __cplusplus
81 }
82 #endif
83
84
85 #endif // SPINLOCK_H