Replaces all __CONFIG_*__ with CONFIG_*
[akaros.git] / user / parlib / spinlock.c
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 #include <stdlib.h>
23 #include <errno.h>
24 #include <assert.h>
25
26 #include <spinlock.h>
27 #include <vcore.h>
28 #include <uthread.h>
29
30 void spinlock_init(spinlock_t *lock)
31 {
32   assert(lock);
33   lock->lock = 0;
34 }
35
36 int spinlock_trylock(spinlock_t *lock) 
37 {
38   assert(lock);
39   return __sync_lock_test_and_set(&lock->lock, EBUSY);
40 }
41
42 /* TODO: this will perform worse than test, then test and set */
43 void spinlock_lock(spinlock_t *lock) 
44 {
45   assert(lock);
46   while (spinlock_trylock(lock))
47     cpu_relax();
48 }
49
50 void spinlock_unlock(spinlock_t *lock) 
51 {
52   assert(lock);
53   __sync_lock_release(&lock->lock, 0);
54 }
55
56 /* Two different versions, with and without CAS.  Default is with CAS. */
57 #ifndef CONFIG_SPINPDR_NO_CAS /* CAS version */
58
59 /* Spin-PRD locks (preemption detection/recovery).  Idea is to CAS and put the
60  * lockholder's vcoreid in the lock, and all spinners ensure that vcore runs. */
61 void spin_pdr_init(struct spin_pdr_lock *pdr_lock)
62 {
63         pdr_lock->lock = SPINPDR_UNLOCKED;
64 }
65
66 /* Internal version of the locking func, doesn't care if notifs are disabled */
67 void __spin_pdr_lock(struct spin_pdr_lock *pdr_lock)
68 {
69         uint32_t vcoreid = vcore_id();
70         uint32_t lock_val;
71         assert(vcoreid != SPINPDR_UNLOCKED);
72         do {
73                 while ((lock_val = pdr_lock->lock) != SPINPDR_UNLOCKED) {
74                         ensure_vcore_runs(lock_val);
75                         cmb();
76                 }
77         } while (!atomic_cas_u32(&pdr_lock->lock, lock_val, vcoreid));
78         cmb();  /* just need a cmb, the CAS handles the CPU wmb/wrmb() */
79 }
80
81 void __spin_pdr_unlock(struct spin_pdr_lock *pdr_lock)
82 {
83         /* could make an arch-dependent 'release barrier' out of these */
84         wmb();  /* Need to prevent the compiler from reordering older stores. */
85         rwmb(); /* And no old reads passing either.   x86 makes both mbs a cmb() */
86         pdr_lock->lock = SPINPDR_UNLOCKED;
87 }
88
89 #else /* NON-CAS version */
90
91 /* Using regular spinlocks, with SPINPDR_VCOREID_UNKNOWN (-1) meaning 'no
92  * lockholder advertised yet'.  There are two spots where the lockholder still
93  * holds the lock but hasn't advertised its vcoreid, and in those cases we
94  * ensure all vcores aren't preempted (linear scan). */
95 void spin_pdr_init(struct spin_pdr_lock *pdr_lock)
96 {
97         spinlock_init(&pdr_lock->spinlock);
98         pdr_lock->lockholder = SPINPDR_VCOREID_UNKNOWN;
99 }
100
101 void __spin_pdr_lock(struct spin_pdr_lock *pdr_lock)
102 {
103         uint32_t vcoreid = vcore_id();
104         uint32_t ensure_tgt;
105         assert(vcoreid != SPINPDR_VCOREID_UNKNOWN);
106         while (spinlock_trylock(&pdr_lock->spinlock)) {
107                 ensure_tgt = pdr_lock->lockholder;
108                 /* ensure will make sure *every* vcore runs if you pass it your self. */
109                 if (ensure_tgt == SPINPDR_VCOREID_UNKNOWN)
110                         ensure_tgt = vcoreid;
111                 ensure_vcore_runs(ensure_tgt);
112                 cpu_relax();
113         }
114         pdr_lock->lockholder = vcoreid;
115 }
116
117 void __spin_pdr_unlock(struct spin_pdr_lock *pdr_lock)
118 {
119         pdr_lock->lockholder = SPINPDR_VCOREID_UNKNOWN;
120         spinlock_unlock(&pdr_lock->spinlock);
121 }
122
123 #endif /* CONFIG_SPINPDR_NO_CAS */
124
125 void spin_pdr_lock(struct spin_pdr_lock *pdr_lock)
126 {
127         /* Disable notifs, if we're an _M uthread */
128         uth_disable_notifs();
129         __spin_pdr_lock(pdr_lock);
130 }
131
132 void spin_pdr_unlock(struct spin_pdr_lock *pdr_lock)
133 {
134         __spin_pdr_unlock(pdr_lock);
135         /* Enable notifs, if we're an _M uthread */
136         uth_enable_notifs();
137 }