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