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