MCS-PDR locks take a *qnode
[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. */
168 void mcs_pdr_init(struct mcs_pdr_lock *lock)
169 {
170         lock->lock = 0;
171 }
172
173 void mcs_pdr_fini(struct mcs_pdr_lock *lock)
174 {
175 }
176
177 /* Internal version of the locking function, doesn't care if notifs are
178  * disabled.  While spinning, we'll check to see if other vcores involved in the
179  * locking are running.  If we change to that vcore, we'll continue when our
180  * vcore gets restarted.  If the change fails, it is because the vcore is
181  * running, and we'll continue.
182  *
183  * It's worth noting that changing to another vcore won't hurt correctness.
184  * Even if they are no longer the lockholder, they will be checking preemption
185  * messages and will help break out of the deadlock.  So long as we don't
186  * spin uncontrollably, we're okay. */
187 void __mcs_pdr_lock(struct mcs_pdr_lock *lock, struct mcs_pdr_qnode *qnode)
188 {
189         struct mcs_pdr_qnode *predecessor;
190         uint32_t pred_vcoreid;
191         /* Now the actual lock */
192         qnode->next = 0;
193         cmb();  /* swap provides a CPU mb() */
194         predecessor = atomic_swap_ptr((void**)&lock->lock, qnode);
195         if (predecessor) {
196                 qnode->locked = 1;
197                 /* Read-in the vcoreid before releasing them.  We won't need to worry
198                  * about their qnode memory being freed/reused (they can't til we fill
199                  * in the 'next' slot), which is a bit of a performance win.  This also
200                  * cuts down on cache-line contention when we ensure they run, which
201                  * helps a lot too. */
202                 pred_vcoreid = ACCESS_ONCE(predecessor->vcoreid);
203                 wmb();  /* order the locked write before the next write */
204                 predecessor->next = qnode;
205                 /* no need for a wrmb(), since this will only get unlocked after they
206                  * read our previous write */
207                 while (qnode->locked) {
208                         /* We don't know who the lock holder is (it hurts performance via
209                          * 'true' sharing to track it)  Instead we'll make sure our pred is
210                          * running, which trickles up to the lock holder. */
211                         ensure_vcore_runs(pred_vcoreid);
212                         cpu_relax();
213                 }
214         }
215 }
216
217 /* Using the CAS style unlocks, since the usurper recovery is a real pain in the
218  * ass */
219 void __mcs_pdr_unlock(struct mcs_pdr_lock *lock, struct mcs_pdr_qnode *qnode)
220 {
221         uint32_t a_tail_vcoreid;
222         /* Check if someone is already waiting on us to unlock */
223         if (qnode->next == 0) {
224                 cmb();  /* no need for CPU mbs, since there's an atomic_cas() */
225                 /* If we're still the lock, just swap it with 0 (unlock) and return */
226                 if (atomic_cas_ptr((void**)&lock->lock, qnode, 0))
227                         return;
228                 /* Read in the tail (or someone who recently was the tail, but could now
229                  * be farther up the chain), in prep for our spinning. */
230                 a_tail_vcoreid = ACCESS_ONCE(lock->lock->vcoreid);
231                 /* We failed, someone is there and we are some (maybe a different)
232                  * thread's pred.  Since someone else was waiting, they should have made
233                  * themselves our next.  Spin (very briefly!) til it happens. */
234                 while (qnode->next == 0) {
235                         /* We need to get our next to run, but we don't know who they are.
236                          * If we make sure a tail is running, that will percolate up to make
237                          * sure our qnode->next is running */
238                         ensure_vcore_runs(a_tail_vcoreid);
239                         cpu_relax();
240                 }
241                 /* Alpha wants a read_barrier_depends() here */
242                 /* Now that we have a next, unlock them */
243                 qnode->next->locked = 0;
244         } else {
245                 /* mb()s necessary since we didn't call an atomic_swap() */
246                 wmb();  /* need to make sure any previous writes don't pass unlocking */
247                 rwmb(); /* need to make sure any reads happen before the unlocking */
248                 /* simply unlock whoever is next */
249                 qnode->next->locked = 0;
250         }
251 }
252
253 /* Actual MCS-PDR locks.  Don't worry about initializing any fields of qnode.
254  * We'll do vcoreid here, and the locking code deals with the other fields */
255 void mcs_pdr_lock(struct mcs_pdr_lock *lock, struct mcs_pdr_qnode *qnode)
256 {
257         /* Disable notifs, if we're an _M uthread */
258         uth_disable_notifs();
259         cmb();  /* in the off-chance the compiler wants to read vcoreid early */
260         qnode->vcoreid = vcore_id();
261         __mcs_pdr_lock(lock, qnode);
262 }
263
264 /* CAS-less unlock, not quite as efficient and will make sure every vcore runs
265  * (since we don't have a convenient way to make sure our qnode->next runs
266  * yet, other than making sure everyone runs).
267  *
268  * To use this without ensuring all vcores run, you'll need the unlock code to
269  * save pred to a specific field in the qnode and check both its initial pred
270  * as well as its run time pred (who could be an usurper).  It's all possible,
271  * but a little more difficult to follow.  Also, I'm adjusting this comment
272  * months after writing it originally, so it is probably not sufficient, but
273  * necessary. */
274 void __mcs_pdr_unlock_no_cas(struct mcs_pdr_lock *lock,
275                              struct mcs_pdr_qnode *qnode)
276 {
277         struct mcs_pdr_qnode *old_tail, *usurper;
278         /* Check if someone is already waiting on us to unlock */
279         if (qnode->next == 0) {
280                 cmb();  /* no need for CPU mbs, since there's an atomic_swap() */
281                 /* Unlock it */
282                 old_tail = atomic_swap_ptr((void**)&lock->lock, 0);
283                 /* no one else was already waiting, so we successfully unlocked and can
284                  * return */
285                 if (old_tail == qnode)
286                         return;
287                 /* someone else was already waiting on the lock (last one on the list),
288                  * and we accidentally took them off.  Try and put it back. */
289                 usurper = atomic_swap_ptr((void*)&lock->lock, old_tail);
290                 /* since someone else was waiting, they should have made themselves our
291                  * next.  spin (very briefly!) til it happens. */
292                 while (qnode->next == 0) {
293                         /* make sure old_tail isn't preempted.  best we can do for now is
294                          * to make sure all vcores run, and thereby get our next. */
295                         for (int i = 0; i < max_vcores(); i++)
296                                 ensure_vcore_runs(i);
297                         cpu_relax();
298                 }
299                 if (usurper) {
300                         /* an usurper is someone who snuck in before we could put the old
301                          * tail back.  They now have the lock.  Let's put whoever is
302                          * supposed to be next as their next one. 
303                          *
304                          * First, we need to change our next's pred.  There's a slight race
305                          * here, so our next will need to make sure both us and pred are
306                          * done */
307                         /* I was trying to do something so we didn't need to ensure all
308                          * vcores run, using more space in the qnode to figure out who our
309                          * pred was a lock time (guessing actually, since there's a race,
310                          * etc). */
311                         //qnode->next->pred = usurper;
312                         //wmb();
313                         usurper->next = qnode->next;
314                         /* could imagine another wmb() and a flag so our next knows to no
315                          * longer check us too. */
316                 } else {
317                         /* No usurper meant we put things back correctly, so we should just
318                          * pass the lock / unlock whoever is next */
319                         qnode->next->locked = 0;
320                 }
321         } else {
322                 /* mb()s necessary since we didn't call an atomic_swap() */
323                 wmb();  /* need to make sure any previous writes don't pass unlocking */
324                 rwmb(); /* need to make sure any reads happen before the unlocking */
325                 /* simply unlock whoever is next */
326                 qnode->next->locked = 0;
327         }
328 }
329
330 void mcs_pdr_unlock(struct mcs_pdr_lock *lock, struct mcs_pdr_qnode *qnode)
331 {
332 #ifndef __riscv__
333         __mcs_pdr_unlock(lock, qnode);
334 #else
335         __mcs_pdr_unlock_no_cas(lock, qnode);
336 #endif
337         /* Enable notifs, if we're an _M uthread */
338         uth_enable_notifs();
339 }