UCQs now use mcs_pdr_locks (XCC)
[akaros.git] / user / parlib / mcs.c
1 #include <vcore.h>
2 #include <mcs.h>
3 #include <arch/atomic.h>
4 #include <string.h>
5 #include <stdlib.h>
6 #include <uthread.h>
7 #include <parlib.h>
8
9 // MCS locks
10 void mcs_lock_init(struct mcs_lock *lock)
11 {
12         memset(lock,0,sizeof(mcs_lock_t));
13 }
14
15 static inline mcs_lock_qnode_t *mcs_qnode_swap(mcs_lock_qnode_t **addr,
16                                                mcs_lock_qnode_t *val)
17 {
18         return (mcs_lock_qnode_t*)atomic_swap_ptr((void**)addr, val);
19 }
20
21 void mcs_lock_lock(struct mcs_lock *lock, struct mcs_lock_qnode *qnode)
22 {
23         qnode->next = 0;
24         cmb();  /* swap provides a CPU mb() */
25         mcs_lock_qnode_t *predecessor = mcs_qnode_swap(&lock->lock, qnode);
26         if (predecessor) {
27                 qnode->locked = 1;
28                 wmb();
29                 predecessor->next = qnode;
30                 /* no need for a wrmb(), since this will only get unlocked after they
31                  * read our previous write */
32                 while (qnode->locked)
33                         cpu_relax();
34         }
35         cmb();  /* just need a cmb, the swap handles the CPU wmb/wrmb() */
36 }
37
38 void mcs_lock_unlock(struct mcs_lock *lock, struct mcs_lock_qnode *qnode)
39 {
40         /* Check if someone is already waiting on us to unlock */
41         if (qnode->next == 0) {
42                 cmb();  /* no need for CPU mbs, since there's an atomic_swap() */
43                 /* Unlock it */
44                 mcs_lock_qnode_t *old_tail = mcs_qnode_swap(&lock->lock,0);
45                 /* no one else was already waiting, so we successfully unlocked and can
46                  * return */
47                 if (old_tail == qnode)
48                         return;
49                 /* someone else was already waiting on the lock (last one on the list),
50                  * and we accidentally took them off.  Try and put it back. */
51                 mcs_lock_qnode_t *usurper = mcs_qnode_swap(&lock->lock,old_tail);
52                 /* since someone else was waiting, they should have made themselves our
53                  * next.  spin (very briefly!) til it happens. */
54                 while (qnode->next == 0)
55                         cpu_relax();
56                 if (usurper) {
57                         /* an usurper is someone who snuck in before we could put the old
58                          * tail back.  They now have the lock.  Let's put whoever is
59                          * supposed to be next as their next one. */
60                         usurper->next = qnode->next;
61                 } else {
62                         /* No usurper meant we put things back correctly, so we should just
63                          * pass the lock / unlock whoever is next */
64                         qnode->next->locked = 0;
65                 }
66         } else {
67                 /* mb()s necessary since we didn't call an atomic_swap() */
68                 wmb();  /* need to make sure any previous writes don't pass unlocking */
69                 rwmb(); /* need to make sure any reads happen before the unlocking */
70                 /* simply unlock whoever is next */
71                 qnode->next->locked = 0;
72         }
73 }
74
75 /* CAS style mcs locks, kept around til we use them.  We're using the
76  * usurper-style, since RISCV and SPARC both don't have a real CAS. */
77 void mcs_lock_unlock_cas(struct mcs_lock *lock, struct mcs_lock_qnode *qnode)
78 {
79         /* Check if someone is already waiting on us to unlock */
80         if (qnode->next == 0) {
81                 cmb();  /* no need for CPU mbs, since there's an atomic_cas() */
82                 /* If we're still the lock, just swap it with 0 (unlock) and return */
83                 if (atomic_cas_ptr((void**)&lock->lock, qnode, 0))
84                         return;
85                 /* We failed, someone is there and we are some (maybe a different)
86                  * thread's pred.  Since someone else was waiting, they should have made
87                  * themselves our next.  Spin (very briefly!) til it happens. */
88                 while (qnode->next == 0)
89                         cpu_relax();
90                 /* Alpha wants a read_barrier_depends() here */
91                 /* Now that we have a next, unlock them */
92                 qnode->next->locked = 0;
93         } else {
94                 /* mb()s necessary since we didn't call an atomic_swap() */
95                 wmb();  /* need to make sure any previous writes don't pass unlocking */
96                 rwmb(); /* need to make sure any reads happen before the unlocking */
97                 /* simply unlock whoever is next */
98                 qnode->next->locked = 0;
99         }
100 }
101
102 /* We don't bother saving the state, like we do with irqsave, since we can use
103  * whether or not we are in vcore context to determine that.  This means you
104  * shouldn't call this from those moments when you fake being in vcore context
105  * (when switching into the TLS, etc). */
106 void mcs_lock_notifsafe(struct mcs_lock *lock, struct mcs_lock_qnode *qnode)
107 {
108         uth_disable_notifs();
109         mcs_lock_lock(lock, qnode);
110 }
111
112 /* Note we turn off the DONT_MIGRATE flag before enabling notifs.  This is fine,
113  * since we wouldn't receive any notifs that could lead to us migrating after we
114  * set DONT_MIGRATE but before enable_notifs().  We need it to be in this order,
115  * since we need to check messages after ~DONT_MIGRATE. */
116 void mcs_unlock_notifsafe(struct mcs_lock *lock, struct mcs_lock_qnode *qnode)
117 {
118         mcs_lock_unlock(lock, qnode);
119         uth_enable_notifs();
120 }
121
122 // MCS dissemination barrier!
123 int mcs_barrier_init(mcs_barrier_t* b, size_t np)
124 {
125         if(np > max_vcores())
126                 return -1;
127         b->allnodes = (mcs_dissem_flags_t*)malloc(np*sizeof(mcs_dissem_flags_t));
128         memset(b->allnodes,0,np*sizeof(mcs_dissem_flags_t));
129         b->nprocs = np;
130
131         b->logp = (np & (np-1)) != 0;
132         while(np >>= 1)
133                 b->logp++;
134
135         size_t i,k;
136         for(i = 0; i < b->nprocs; i++)
137         {
138                 b->allnodes[i].parity = 0;
139                 b->allnodes[i].sense = 1;
140
141                 for(k = 0; k < b->logp; k++)
142                 {
143                         size_t j = (i+(1<<k)) % b->nprocs;
144                         b->allnodes[i].partnerflags[0][k] = &b->allnodes[j].myflags[0][k];
145                         b->allnodes[i].partnerflags[1][k] = &b->allnodes[j].myflags[1][k];
146                 } 
147         }
148
149         return 0;
150 }
151
152 void mcs_barrier_wait(mcs_barrier_t* b, size_t pid)
153 {
154         mcs_dissem_flags_t* localflags = &b->allnodes[pid];
155         size_t i;
156         for(i = 0; i < b->logp; i++)
157         {
158                 *localflags->partnerflags[localflags->parity][i] = localflags->sense;
159                 while(localflags->myflags[localflags->parity][i] != localflags->sense);
160         }
161         if(localflags->parity)
162                 localflags->sense = 1-localflags->sense;
163         localflags->parity = 1-localflags->parity;
164 }
165
166 /* Preemption detection and recovering MCS locks.  These are memory safe ones.
167  * In the future, we can make ones that you pass the qnode to, so long as you
168  * never free the qnode storage (stacks) */
169 void mcs_pdr_init(struct mcs_pdr_lock *lock)
170 {
171         lock->lock = 0;
172         lock->lock_holder = 0;
173         lock->vc_qnodes = malloc(sizeof(struct mcs_pdr_qnode) * max_vcores());
174         assert(lock->vc_qnodes);
175         for (int i = 0; i < max_vcores(); i++)
176                 lock->vc_qnodes[i].vcoreid = i;
177 }
178
179 void mcs_pdr_fini(struct mcs_pdr_lock *lock)
180 {
181         assert(lock->vc_qnodes);
182         free(lock->vc_qnodes);
183 }
184
185 /* Helper, will make sure the vcore owning qnode is running.  If we change to
186  * that vcore, we'll continue when our vcore gets restarted.  If the change
187  * fails, it is because the vcore is running, and we'll continue.
188  *
189  * It's worth noting that changing to another vcore won't hurt correctness.
190  * Even if they are no longer the lockholder, they will be checking preemption
191  * messages and will help break out of the deadlock.  So long as we don't
192  * wastefully spin, we're okay. */
193 void __ensure_qnode_runs(struct mcs_pdr_qnode *qnode)
194 {
195         if (!vcore_is_mapped(qnode->vcoreid)) {
196                 /* We want to recover them from preemption.  Since we know they have
197                  * notifs disabled, they will need to be directly restarted, so we can
198                  * skip the other logic and cut straight to the sys_change_vcore() */
199                 sys_change_vcore(qnode->vcoreid, FALSE);
200                 cmb();
201         }
202 }
203
204 /* Internal version of the locking function, doesn't care about storage of qnode
205  * or if notifs are disabled. */
206 void __mcs_pdr_lock(struct mcs_pdr_lock *lock, struct mcs_pdr_qnode *qnode)
207 {
208         struct mcs_pdr_qnode *predecessor;
209         /* Now the actual lock */
210         qnode->next = 0;
211         cmb();  /* swap provides a CPU mb() */
212         predecessor = atomic_swap_ptr((void**)&lock->lock, qnode);
213         if (predecessor) {
214                 qnode->locked = 1;
215                 wmb();
216                 predecessor->next = qnode;
217                 /* no need for a wrmb(), since this will only get unlocked after they
218                  * read our previous write */
219                 while (qnode->locked) {
220                         /* Ideally, we know who the lock holder is, and we'll make sure they
221                          * run.  If not, we'll make sure our pred is running, which trickles
222                          * up to the lock holder, if it isn't them. */
223                         if (lock->lock_holder)
224                                 __ensure_qnode_runs(lock->lock_holder);
225                         else
226                                 __ensure_qnode_runs(predecessor);
227                         cpu_relax();
228                 }
229         }
230         cmb();  /* just need a cmb, the swap handles the CPU wmb/wrmb() */
231         /* publish ourselves as the lock holder (optimization) */
232         lock->lock_holder = qnode;      /* mbs() handled by the cmb/swap */
233 }
234
235 /* Using the CAS style unlocks, since the usurper recovery is a real pain in the
236  * ass */
237 void __mcs_pdr_unlock(struct mcs_pdr_lock *lock, struct mcs_pdr_qnode *qnode)
238 {
239         struct mcs_pdr_qnode *a_tail;
240         /* Clear us from being the lock holder */
241         lock->lock_holder = 0;  /* mbs() are covered by the cmb/cas and the wmb */
242         /* Check if someone is already waiting on us to unlock */
243         if (qnode->next == 0) {
244                 cmb();  /* no need for CPU mbs, since there's an atomic_cas() */
245                 /* If we're still the lock, just swap it with 0 (unlock) and return */
246                 if (atomic_cas_ptr((void**)&lock->lock, qnode, 0))
247                         return;
248                 cmb();  /* need to read a fresh tail.  the CAS was a CPU mb */
249                 /* Read in the tail (or someone who recent was the tail, but could now
250                  * be farther up the chain), in prep for our spinning. */
251                 a_tail = lock->lock;
252                 /* We failed, someone is there and we are some (maybe a different)
253                  * thread's pred.  Since someone else was waiting, they should have made
254                  * themselves our next.  Spin (very briefly!) til it happens. */
255                 while (qnode->next == 0) {
256                         /* We need to get our next to run, but we don't know who they are.
257                          * If we make sure a tail is running, that will percolate up to make
258                          * sure our qnode->next is running */
259                         __ensure_qnode_runs(a_tail);
260                         /* Arguably, that reads new tails each time, but it'll still work
261                          * for this rare case */
262                         cpu_relax();
263                 }
264                 /* Alpha wants a read_barrier_depends() here */
265                 /* Now that we have a next, unlock them */
266                 qnode->next->locked = 0;
267         } else {
268                 /* mb()s necessary since we didn't call an atomic_swap() */
269                 wmb();  /* need to make sure any previous writes don't pass unlocking */
270                 rwmb(); /* need to make sure any reads happen before the unlocking */
271                 /* simply unlock whoever is next */
272                 qnode->next->locked = 0;
273         }
274 }
275
276 /* Actual MCS-PDR locks.  These use memory in the lock for their qnodes, though
277  * the internal locking code doesn't care where the qnodes come from: so long as
278  * they are not freed and can stand a random read of vcoreid. */
279 void mcs_pdr_lock(struct mcs_pdr_lock *lock)
280 {
281         struct mcs_pdr_qnode *qnode;
282         /* Disable notifs, if we're an _M uthread */
283         uth_disable_notifs();
284         /* Get our qnode from the array.  vcoreid was preset, and the other fields
285          * get handled by the lock */
286         qnode = &lock->vc_qnodes[vcore_id()];
287         assert(qnode->vcoreid == vcore_id());   /* sanity */
288         __mcs_pdr_lock(lock, qnode);
289 }
290
291 void mcs_pdr_unlock(struct mcs_pdr_lock *lock)
292 {
293         struct mcs_pdr_qnode *qnode = &lock->vc_qnodes[vcore_id()];
294         assert(qnode->vcoreid == vcore_id());   /* sanity */
295         __mcs_pdr_unlock(lock, qnode);
296         /* Enable notifs, if we're an _M uthread */
297         uth_enable_notifs();
298 }
299
300 #if 0
301 /* We don't actually use this.  To use this, you'll need the unlock code to save
302  * pred to a specific field in the qnode and check both its initial pred as well
303  * as its run time pred (who could be an usurper).  It's all possible, but a
304  * little more difficult to follow. */
305 void __mcs_pdr_unlock_no_cas(struct mcs_pdr_lock *lock,
306                              struct mcs_pdr_qnode *qnode)
307 {
308         struct mcs_pdr_qnode *old_tail, *usurper;
309         /* Check if someone is already waiting on us to unlock */
310         if (qnode->next == 0) {
311                 cmb();  /* no need for CPU mbs, since there's an atomic_swap() */
312                 /* Unlock it */
313                 old_tail = atomic_swap_ptr((void**)&lock->lock, 0);
314                 /* no one else was already waiting, so we successfully unlocked and can
315                  * return */
316                 if (old_tail == qnode)
317                         return;
318                 /* someone else was already waiting on the lock (last one on the list),
319                  * and we accidentally took them off.  Try and put it back. */
320                 usurper = atomic_swap_ptr((void*)&lock->lock, old_tail);
321                 /* since someone else was waiting, they should have made themselves our
322                  * next.  spin (very briefly!) til it happens. */
323                 while (qnode->next == 0) {
324                         /* make sure old_tail isn't preempted */
325
326                         cpu_relax();
327                 }
328                 if (usurper) {
329                         /* an usurper is someone who snuck in before we could put the old
330                          * tail back.  They now have the lock.  Let's put whoever is
331                          * supposed to be next as their next one. 
332                          *
333                          * First, we need to change our next's pred.  There's a slight race
334                          * here, so our next will need to make sure both us and pred are
335                          * done */
336                         qnode->next->pred = usurper;
337                         wmb();
338                         usurper->next = qnode->next;
339                         /* could imagine another wmb() and a flag so our next knows to no
340                          * longer check us too. */
341                 } else {
342                         /* No usurper meant we put things back correctly, so we should just
343                          * pass the lock / unlock whoever is next */
344                         qnode->next->locked = 0;
345                 }
346         } else {
347                 /* mb()s necessary since we didn't call an atomic_swap() */
348                 wmb();  /* need to make sure any previous writes don't pass unlocking */
349                 rwmb(); /* need to make sure any reads happen before the unlocking */
350                 /* simply unlock whoever is next */
351                 qnode->next->locked = 0;
352         }
353 }
354 #endif