Remove the option to spawn_thread for an evq (XCC)
[akaros.git] / user / parlib / event.c
1 /* Copyright (c) 2011-2014 The Regents of the University of California
2  * Copyright (c) 2015 Google Inc
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  *
6  * Userspace utility functions for receiving events and notifications (IPIs).
7  * Some are higher level than others; just use what you need. */ 
8
9 #include <ros/event.h>
10 #include <ros/procdata.h>
11 #include <parlib/ucq.h>
12 #include <parlib/bitmask.h>
13 #include <parlib/vcore.h>
14 #include <stdlib.h>
15 #include <string.h>
16 #include <assert.h>
17 #include <errno.h>
18 #include <parlib/parlib.h>
19 #include <parlib/event.h>
20 #include <parlib/uthread.h>
21 #include <parlib/spinlock.h>
22 #include <parlib/mcs.h>
23 #include <parlib/poke.h>
24 #include <sys/queue.h>
25 #include <malloc.h>
26
27 /* For remote VCPD mbox event handling */
28 __thread bool __vc_handle_an_mbox = FALSE;
29 __thread uint32_t __vc_rem_vcoreid;
30
31 /********* Event_q Setup / Registration  ***********/
32
33 /* Get event_qs via these interfaces, since eventually we'll want to either
34  * allocate from pinned memory or use some form of a slab allocator.  Also,
35  * these stitch up the big_q so its ev_mbox points to its internal mbox.  Never
36  * access the internal mbox directly.
37  *
38  * Raw ones need to have their UCQs initialized.  If you're making a lot of
39  * these, you can do one big mmap and init the ucqs on your own, which ought to
40  * perform better.
41  *
42  * Use the 'regular' one for big_qs if you don't want to worry about the ucq
43  * initalization */
44 struct event_queue *get_big_event_q_raw(void)
45 {
46         /* TODO: (PIN) should be pinned memory */
47         struct event_queue_big *big_q = malloc(sizeof(struct event_queue_big));
48         memset(big_q, 0, sizeof(struct event_queue_big));
49         big_q->ev_mbox = &big_q->ev_imbox;
50         return (struct event_queue*)big_q;
51 }
52
53 struct event_queue *get_big_event_q(void)
54 {
55         struct event_queue *big_q = get_big_event_q_raw();
56         /* uses the simpler, internally mmapping ucq_init() */
57         ucq_init(&big_q->ev_mbox->ev_msgs);
58         return big_q;
59 }
60
61 /* Give it up.  I don't recommend calling these unless you're sure the queues
62  * aren't in use (unregistered, etc). (TODO: consider some checks for this) */
63 void put_big_event_q_raw(struct event_queue *ev_q)
64 {
65         /* if we use something other than malloc, we'll need to be aware that ev_q
66          * is actually an event_queue_big.  One option is to use the flags, though
67          * this could be error prone. */
68         free(ev_q);
69 }
70
71 void put_big_event_q(struct event_queue *ev_q)
72 {
73         ucq_free_pgs(&ev_q->ev_mbox->ev_msgs);
74         put_big_event_q_raw(ev_q);
75 }
76
77 /* Need to point this event_q to an mbox - usually to a vcpd */
78 struct event_queue *get_event_q(void)
79 {
80         /* TODO: (PIN) should be pinned memory */
81         struct event_queue *ev_q = malloc(sizeof(struct event_queue));
82         memset(ev_q, 0, sizeof(struct event_queue));
83         return ev_q;
84 }
85
86 /* Gets a small ev_q, with ev_mbox pointing to the vcpd mbox of vcoreid.  If
87  * ev_flags has EVENT_VCORE_PRIVATE set, it'll give you the private mbox.  o/w,
88  * you'll get the public one. */
89 struct event_queue *get_event_q_vcpd(uint32_t vcoreid, int ev_flags)
90 {
91         struct event_queue *ev_q = get_event_q();
92         if (ev_flags & EVENT_VCORE_PRIVATE)
93                 ev_q->ev_mbox = &vcpd_of(vcoreid)->ev_mbox_private;
94         else
95                 ev_q->ev_mbox = &vcpd_of(vcoreid)->ev_mbox_public;
96         return ev_q;
97 }
98
99 void put_event_q(struct event_queue *ev_q)
100 {
101         /* if we use something other than malloc, we'll need to be aware that ev_q
102          * is not an event_queue_big. */
103         free(ev_q);
104 }
105
106 /* Sets ev_q to be the receiving end for kernel event ev_type */
107 void register_kevent_q(struct event_queue *ev_q, unsigned int ev_type)
108 {
109         __procdata.kernel_evts[ev_type] = ev_q;
110 }
111
112 /* Clears the event, returning an ev_q if there was one there.  You'll need to
113  * free it. */
114 struct event_queue *clear_kevent_q(unsigned int ev_type)
115 {
116         struct event_queue *ev_q = __procdata.kernel_evts[ev_type];
117         __procdata.kernel_evts[ev_type] = 0;
118         return ev_q;
119 }
120
121 /* Enables an IPI/event combo for ev_type sent to vcoreid's default mbox.  IPI
122  * if you want one or not.  If you want the event to go to the vcore private
123  * mbox (meaning no other core should ever handle it), send in
124  * EVENT_VCORE_PRIVATE with ev_flags.
125  *
126  * This is the simplest thing applications may want, and shows how you can put
127  * the other event functions together to get similar things done. */
128 void enable_kevent(unsigned int ev_type, uint32_t vcoreid, int ev_flags)
129 {
130         struct event_queue *ev_q = get_event_q_vcpd(vcoreid, ev_flags);
131         ev_q->ev_flags = ev_flags;
132         ev_q->ev_vcore = vcoreid;
133         ev_q->ev_handler = 0;
134         wmb();  /* make sure ev_q is filled out before registering */
135         register_kevent_q(ev_q, ev_type);
136 }
137
138 /* Stop receiving the events (one could be on the way).  Caller needs to be
139  * careful, since the kernel might be sending an event to the ev_q.  Depending
140  * on the ev_q, it may be hard to know when it is done (for instance, if all
141  * syscalls you ever registered with the ev_q are done, then it would be okay).
142  * o/w, don't free it. */
143 struct event_queue *disable_kevent(unsigned int ev_type)
144 {
145         return clear_kevent_q(ev_type);
146 }
147
148 /********* Event Handling / Reception ***********/
149 /* Somewhat ghetto helper, for the lazy.  If all you care about is an event
150  * number, this will see if the event happened or not.  It will try for a
151  * message, but if there is none, it will go for a bit.  Note that multiple
152  * bit messages will turn into just one bit. */
153 unsigned int get_event_type(struct event_mbox *ev_mbox)
154 {
155         struct event_msg local_msg = {0};
156
157         if (extract_one_mbox_msg(ev_mbox, &local_msg))
158                 return local_msg.ev_type;
159         if (BITMASK_IS_CLEAR(&ev_mbox->ev_bitmap, MAX_NR_EVENT))
160                 return EV_NONE; /* aka, 0 */
161         for (int i = 0; i < MAX_NR_EVENT; i++) {
162                 if (GET_BITMASK_BIT(ev_mbox->ev_bitmap, i)) {
163                         CLR_BITMASK_BIT_ATOMIC(ev_mbox->ev_bitmap, i);
164                         return i;
165                 }
166         }
167         return EV_NONE;
168 }
169
170 /* Actual Event Handling */
171
172 /* List of handler lists, process-wide.  They all must return (don't context
173  * switch to a u_thread) */
174 struct ev_handler *ev_handlers[MAX_NR_EVENT] = {0};
175 spinpdrlock_t ev_h_wlock = SPINPDR_INITIALIZER;
176
177 int register_ev_handler(unsigned int ev_type, handle_event_t handler,
178                         void *data)
179 {
180         struct ev_handler *new_h = malloc(sizeof(struct ev_handler));
181         if (!new_h)
182                 return -1;
183         new_h->func = handler;
184         new_h->data = data;
185         spin_pdr_lock(&ev_h_wlock);
186         new_h->next = ev_handlers[ev_type];
187         wmb();  /* make sure new_h is done before publishing to readers */
188         ev_handlers[ev_type] = new_h;
189         spin_pdr_unlock(&ev_h_wlock);
190         return 0;
191 }
192
193 int deregister_ev_handler(unsigned int ev_type, handle_event_t handler,
194                           void *data)
195 {
196         /* TODO: User-level RCU */
197         printf("Failed to dereg handler, not supported yet!\n");
198 }
199
200 static void run_ev_handlers(unsigned int ev_type, struct event_msg *ev_msg)
201 {
202         struct ev_handler *handler;
203         /* TODO: RCU read lock */
204         handler = ev_handlers[ev_type];
205         while (handler) {
206                 handler->func(ev_msg, ev_type, handler->data);
207                 handler = handler->next;
208         }
209 }
210
211 /* Attempts to extract a message from an mbox, copying it into ev_msg.
212  * Returns TRUE on success. */
213 bool extract_one_mbox_msg(struct event_mbox *ev_mbox, struct event_msg *ev_msg)
214 {
215         /* get_ucq returns 0 on success, -1 on empty */
216         return get_ucq_msg(&ev_mbox->ev_msgs, ev_msg) == 0;
217 }
218
219 /* Attempts to handle a message.  Returns 1 if we dequeued a msg, 0 o/w. */
220 int handle_one_mbox_msg(struct event_mbox *ev_mbox)
221 {
222         struct event_msg local_msg;
223         unsigned int ev_type;
224         /* extract returns TRUE on success, we return 1. */
225         if (!extract_one_mbox_msg(ev_mbox, &local_msg))
226                 return 0;
227         ev_type = local_msg.ev_type;
228         assert(ev_type < MAX_NR_EVENT);
229         printd("[event] UCQ (mbox %08p), ev_type: %d\n", ev_mbox, ev_type);
230         run_ev_handlers(ev_type, &local_msg);
231         return 1;
232 }
233
234 /* Handle an mbox.  This is the receive-side processing of an event_queue.  It
235  * takes an ev_mbox, since the vcpd mbox isn't a regular ev_q.  Returns 1 if we
236  * handled something, 0 o/w. */
237 int handle_mbox(struct event_mbox *ev_mbox)
238 {
239         int retval = 0;
240         uint32_t vcoreid = vcore_id();
241         void bit_handler(unsigned int bit) {
242                 printd("[event] Bit: ev_type: %d\n", bit);
243                 run_ev_handlers(bit, 0);
244                 retval = 1;
245                 /* Consider checking the queue for incoming messages while we're here */
246         }
247         printd("[event] handling ev_mbox %08p on vcore %d\n", ev_mbox, vcore_id());
248         /* Some stack-smashing bugs cause this to fail */
249         assert(ev_mbox);
250         /* Handle all full messages, tracking if we do at least one. */
251         while (handle_one_mbox_msg(ev_mbox))
252                 retval = 1;
253         /* Process all bits, if the kernel tells us any bit is set.  We don't clear
254          * the flag til after we check everything, in case one of the handlers
255          * doesn't return.  After we clear it, we recheck. */
256         if (ev_mbox->ev_check_bits) {
257                 do {
258                         ev_mbox->ev_check_bits = TRUE;  /* in case we don't return */
259                         cmb();
260                         BITMASK_FOREACH_SET(ev_mbox->ev_bitmap, MAX_NR_EVENT, bit_handler,
261                                             TRUE);
262                         ev_mbox->ev_check_bits = FALSE;
263                         wrmb(); /* check_bits written before we check for it being clear */
264                 } while (!BITMASK_IS_CLEAR(ev_mbox->ev_bitmap, MAX_NR_EVENT));
265         }
266         return retval;
267 }
268
269 /* Empty if the UCQ is empty and the bits don't need checked */
270 bool mbox_is_empty(struct event_mbox *ev_mbox)
271 {
272         return (ucq_is_empty(&ev_mbox->ev_msgs) && (!ev_mbox->ev_check_bits));
273 }
274
275 /* The EV_EVENT handler - extract the ev_q from the message. */
276 void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type, void *data)
277 {
278         struct event_queue *ev_q;
279         /* EV_EVENT can't handle not having a message / being a bit.  If we got a
280          * bit message, it's a bug somewhere */
281         assert(ev_msg);
282         ev_q = ev_msg->ev_arg3;
283         /* Same deal, a null ev_q is probably a bug, or someone being a jackass */
284         assert(ev_q);
285         /* Clear pending, so we can start getting INDIRs and IPIs again.  We must
286          * set this before (compared to handle_events, then set it, then handle
287          * again), since there is no guarantee handle_event_q() will return.  If
288          * there is a pending preemption, the vcore quickly yields and will deal
289          * with the remaining events in the future - meaning it won't return to
290          * here. */
291         ev_q->ev_alert_pending = FALSE;
292         wmb();  /* don't let the pending write pass the signaling of an ev recv */
293         handle_event_q(ev_q);
294 }
295
296 /* Handles VCPD events (public and private).  The kernel always sets
297  * notif_pending after posting a message to either public or private mailbox.
298  * When this returns, as far as we are concerned, notif_pending is FALSE.
299  * However, a concurrent kernel writer could have reset it to true.  This is
300  * fine; whenever we leave VC ctx we double check notif_pending.  Returns 1 or 2
301  * if we actually handled a message, 0 o/w.
302  *
303  * WARNING: this might not return and/or current_uthread may change. */
304 int handle_events(uint32_t vcoreid)
305 {
306         struct preempt_data *vcpd = vcpd_of(vcoreid);
307         int retval = 0;
308         vcpd->notif_pending = FALSE;
309         wrmb(); /* prevent future reads from happening before notif_p write */
310         retval += handle_mbox(&vcpd->ev_mbox_private);
311         retval += handle_mbox(&vcpd->ev_mbox_public);
312         return retval;
313 }
314
315 /* Handles the events on ev_q IAW the event_handlers[].  If the ev_q is
316  * application specific, then this will dispatch/handle based on its flags. */
317 void handle_event_q(struct event_queue *ev_q)
318 {
319         /* If the program wants to handle the ev_q on its own: */
320         if (ev_q->ev_flags & EVENT_JUSTHANDLEIT) {
321                 if (!ev_q->ev_handler) {
322                         printf("No ev_handler installed for ev_q %08p, aborting!\n", ev_q);
323                         return;
324                 }
325                 /* Remember this can't block or page fault */
326                 ev_q->ev_handler(ev_q);
327                 return;
328         }
329         printd("[event] handling ev_q %08p on vcore %d\n", ev_q, vcore_id());
330         /* Raw ev_qs that haven't been connected to an mbox, user bug: */
331         assert(ev_q->ev_mbox);
332         handle_mbox(ev_q->ev_mbox);
333 }
334
335 /* Sends the calling vcore a message to its public mbox.  This is purposefully
336  * limited to just the calling vcore, since in future versions, we can send via
337  * ucqs directly (in many cases).  That will require the caller to be the
338  * vcoreid, due to some preemption recovery issues (another ucq poller is
339  * waiting on us when we got preempted, and we never up nr_cons). */
340 void send_self_vc_msg(struct event_msg *ev_msg)
341 {
342         // TODO: try to use UCQs (requires additional support)
343         /* ev_type actually gets ignored currently.  ev_msg is what matters if it is
344          * non-zero.  FALSE means it's going to the public mbox */
345         sys_self_notify(vcore_id(), ev_msg->ev_type, ev_msg, FALSE);
346 }
347
348 /* Helper: makes the current core handle a remote vcore's VCPD public mbox events.
349  *
350  * Both cases (whether we are handling someone else's already or not) use some
351  * method of telling our future self what to do.  When we aren't already
352  * handling it, we use TLS, and jump to vcore entry.  When we are already
353  * handling, then we send a message to ourself, which we deal with when we
354  * handle our own events (which is later in vcore entry).
355  *
356  * We need to reset the stack and deal with it in vcore entry to avoid recursing
357  * deeply and running off the transition stack.  (handler calling handle event).
358  *
359  * Note that we might not be the one that gets the message we send.  If we pull
360  * a sys_change_to, someone else might be polling our public message box.  All
361  * we're doing is making sure that we don't forget to check rem_vcoreid's mbox.
362  *
363  * Finally, note that this function might not return.  However, it'll handle the
364  * details related to vcpd mboxes, so you don't use the ev_might_not_return()
365  * helpers with this. */
366 void handle_vcpd_mbox(uint32_t rem_vcoreid)
367 {
368         uint32_t vcoreid = vcore_id();
369         struct preempt_data *vcpd = vcpd_of(vcoreid);
370         struct event_msg local_msg = {0};
371         assert(vcoreid != rem_vcoreid);                 /* this shouldn't happen */
372         /* If they are empty, then we're done */
373         if (mbox_is_empty(&vcpd_of(rem_vcoreid)->ev_mbox_public))
374                 return;
375         if (__vc_handle_an_mbox) {
376                 /* we might be already handling them, in which case, abort */
377                 if (__vc_rem_vcoreid == rem_vcoreid)
378                         return;
379                 /* Already handling message for someone, need to send ourselves a
380                  * message to check rem_vcoreid, which we'll process later. */
381                 local_msg.ev_type = EV_CHECK_MSGS;
382                 local_msg.ev_arg2 = rem_vcoreid;        /* 32bit arg */
383                 send_self_vc_msg(&local_msg);
384                 return;
385         }
386         /* No return after here */
387         /* At this point, we aren't in the process of handling someone else's
388          * messages, so just tell our future self what to do */
389         __vc_handle_an_mbox = TRUE;
390         __vc_rem_vcoreid = rem_vcoreid;
391         /* Reset the stack and start over in vcore context */
392         set_stack_pointer((void*)vcpd->vcore_stack);
393         vcore_entry();
394         assert(0);
395 }
396
397 /* Handle remote vcpd public mboxes, if that's what we want to do.  Call this
398  * from vcore entry, pairs with handle_vcpd_mbox(). */
399 void try_handle_remote_mbox(void)
400 {
401         if (__vc_handle_an_mbox) {
402                 handle_mbox(&vcpd_of(__vc_rem_vcoreid)->ev_mbox_public);
403                 /* only clear the flag when we have returned from handling messages.  if
404                  * an event handler (like preempt_recover) doesn't return, we'll clear
405                  * this flag elsewhere. (it's actually not a big deal if we don't). */
406                 cmb();
407                 __vc_handle_an_mbox = FALSE;
408         }
409 }
410
411 /* Event handler helpers */
412
413 /* For event handlers that might not return, we need to call this before the
414  * command that might not return.  In the event we were handling a remote
415  * vcore's messages, it'll send ourselves a messages that we (or someone who
416  * polls us) will get so that someone finishes off that vcore's messages).
417  * Doesn't matter who does, so long as someone does.
418  *
419  * This returns whether or not we were handling someone's messages.  Pass the
420  * parameter to ev_we_returned() */
421 bool ev_might_not_return(void)
422 {
423         struct event_msg local_msg = {0};
424         bool were_handling_remotes = FALSE;
425         if (__vc_handle_an_mbox) {
426                 /* slight chance we finished with their mbox (were on the last one) */
427                 if (!mbox_is_empty(&vcpd_of(__vc_rem_vcoreid)->ev_mbox_public)) {
428                         /* But we aren't, so we'll need to send a message */
429                         local_msg.ev_type = EV_CHECK_MSGS;
430                         local_msg.ev_arg2 = __vc_rem_vcoreid;   /* 32bit arg */
431                         send_self_vc_msg(&local_msg);
432                 }
433                 /* Either way, we're not working on this one now.  Note this is more of
434                  * an optimization - it'd be harmless (I think) to poll another vcore's
435                  * pub mbox once when we pop up in vc_entry in the future */
436                 __vc_handle_an_mbox = FALSE;
437                 return TRUE;
438         }
439         return FALSE;
440 }
441
442 /* Call this when you return, paired up with ev_might_not_return().  If
443  * ev_might_not_return turned off uth_handle, we'll turn it back on. */
444 void ev_we_returned(bool were_handling_remotes)
445 {
446         if (were_handling_remotes)
447                 __vc_handle_an_mbox = TRUE;
448 }
449
450 /* Debugging */
451 void print_ev_msg(struct event_msg *msg)
452 {
453         printf("MSG at %08p\n", msg);
454         printf("\ttype: %d\n", msg->ev_type);
455         printf("\targ1 (16): 0x%4x\n", msg->ev_arg1);
456         printf("\targ2 (32): 0x%8x\n", msg->ev_arg2);
457         printf("\targ3 (32): 0x%8x\n", msg->ev_arg3);
458         printf("\targ4 (64): 0x%16x\n", msg->ev_arg4);
459 }
460
461 /* Uthreads blocking on event queues
462  *
463  * It'd be nice to have a uthread sleep until an event queue has some activity
464  * (e.g. a new message).  It'd also be nice to wake up early with a timer.  It
465  * is tempting to try something like an INDIR and have one evq multiplex two
466  * others (the real event and an alarm).  But then you can't separate the two
467  * streams; what if one thread sleeps on just the event at the same time?  What
468  * if we want to support something like Go's select: a thread wants to block
469  * until there is some activity on some channel?
470  *
471  * Ultimately, we want to allow M uthreads to block on possibly different
472  * subsets of N event queues.
473  *
474  * Every uthread will have a sleep controller, and every event queue will have a
475  * wakeup controller.  There are up to MxN linkage structures connecting these.
476  *
477  * We'll use the event_queue handler to override the default event processing.
478  * This means the event queues that are used for blocking uthreads can *only* be
479  * used for that; the regular event processing will not happen.  This is mostly
480  * true.  It is possible to extract events from an evq's mbox concurrently.
481  *
482  * I briefly considered having one global lock to protect all of the lists and
483  * structures.  That's lousy for the obvious scalability reason, but it seemed
484  * like it'd make things easier, especially when I thought I needed locks in
485  * both the ectlr and the uctlr (in early versions, I considered having the
486  * handler yank itself out of the ectlr, copying a message into that struct, or
487  * o/w needing protection).  On occasion, we run into the "I'd like to split my
488  * lock between two components and still somehow synchronize" issue (e.g. FD
489  * taps, with the FDT lock and the blocking/whatever that goes on in a device).
490  * Whenever that comes up, we usually can get some help from other shared memory
491  * techniques.  For FD taps, it's the kref.  For us, it's post-and-poke, though
492  * it didn't solve all of our problems - I use it as a tool with some basic
493  * shared memory signalling. */
494
495 struct evq_wait_link;
496 TAILQ_HEAD(wait_link_tailq, evq_wait_link);
497
498 /* Bookkeeping for the uthread sleeping on a bunch of event queues.
499  *
500  * Notes on concurrency: most fields are not protected.  check_evqs is racy, and
501  * written to by handlers.  The tailq is only used by the uthread.  blocked is
502  * never concurrently *written*; see __uth_wakeup_poke() for details. */
503 struct uth_sleep_ctlr {
504         struct uthread                          *uth;
505         struct spin_pdr_lock            in_use;
506         bool                                            check_evqs;
507         bool                                            blocked;
508         struct poke_tracker                     poker;
509         struct wait_link_tailq          evqs;
510 };
511
512 /* Attaches to an event_queue (ev_udata), tracks the uthreads for this evq */
513 struct evq_wakeup_ctlr {
514         struct wait_link_tailq          waiters;
515         struct spin_pdr_lock            lock;
516 };
517
518 /* Up to MxN of these, N of them per uthread. */
519 struct evq_wait_link {
520         struct uth_sleep_ctlr           *uth_ctlr;
521         TAILQ_ENTRY(evq_wait_link)      link_uth;
522         struct evq_wakeup_ctlr          *evq_ctlr;
523         TAILQ_ENTRY(evq_wait_link)      link_evq;
524 };
525
526 /* Poke function: ensures the uth managed by uctlr wakes up.  poke() ensures
527  * there is only one thread in this function at a time.  However, it could be
528  * called spuriously, which is why we check 'blocked.' */
529 static void __uth_wakeup_poke(void *arg)
530 {
531         struct uth_sleep_ctlr *uctlr = arg;
532         /* There are no concurrent writes to 'blocked'.  Blocked is only ever
533          * written when the uth sleeps and only ever cleared here.  Once the uth
534          * writes it, it does not write it again until after we clear it.
535          *
536          * This is still racy - we could see !blocked, then blocked gets set.  In
537          * that case, the poke failed, and that is harmless.  The uth will see
538          * 'check_evqs', which was set before poke, which would be before writing
539          * blocked, and the uth checks 'check_evqs' after writing. */
540         if (uctlr->blocked) {
541                 uctlr->blocked = FALSE;
542                 cmb();  /* clear blocked before starting the uth */
543                 uthread_runnable(uctlr->uth);
544         }
545 }
546
547 static void uth_sleep_ctlr_init(struct uth_sleep_ctlr *uctlr,
548                                 struct uthread *uth)
549 {
550         uctlr->uth = uth;
551         spin_pdr_init(&uctlr->in_use);
552         uctlr->check_evqs = FALSE;
553         uctlr->blocked = FALSE;
554         poke_init(&uctlr->poker, __uth_wakeup_poke);
555         TAILQ_INIT(&uctlr->evqs);
556 }
557
558 /* This handler runs when the ev_q is checked.  Instead of doing anything with
559  * the ev_q, we make sure that every uthread that was waiting on us wakes up.
560  * The uthreads could be waiting on several evqs, so there could be multiple
561  * independent wake-up attempts, hence the poke.  Likewise, the uthread could be
562  * awake when we poke.  The uthread will check check_evqs after sleeping, in
563  * case we poke before it blocks (and the poke fails).
564  *
565  * Also, there could be concurrent callers of this handler, and other uthreads
566  * signing up for a wakeup. */
567 void evq_wakeup_handler(struct event_queue *ev_q)
568 {
569         struct evq_wakeup_ctlr *ectlr = ev_q->ev_udata;
570         struct evq_wait_link *i;
571         assert(ectlr);
572         spin_pdr_lock(&ectlr->lock);
573         /* Note we wake up all sleepers, even though only one is likely to get the
574          * message.  See the notes in unlink_ectlr() for more info. */
575         TAILQ_FOREACH(i, &ectlr->waiters, link_evq) {
576                 i->uth_ctlr->check_evqs = TRUE;
577                 cmb();  /* order check write before poke (poke has atomic) */
578                 poke(&i->uth_ctlr->poker, i->uth_ctlr);
579         }
580         spin_pdr_unlock(&ectlr->lock);
581 }
582
583 /* Helper, attaches a wakeup controller to the event queue. */
584 void evq_attach_wakeup_ctlr(struct event_queue *ev_q)
585 {
586         struct evq_wakeup_ctlr *ectlr = malloc(sizeof(struct evq_wakeup_ctlr));
587         memset(ectlr, 0, sizeof(struct evq_wakeup_ctlr));
588         spin_pdr_init(&ectlr->lock);
589         TAILQ_INIT(&ectlr->waiters);
590         ev_q->ev_udata = ectlr;
591         ev_q->ev_handler = evq_wakeup_handler;
592 }
593
594 void evq_remove_wakeup_ctlr(struct event_queue *ev_q)
595 {
596         free(ev_q->ev_udata);
597         ev_q->ev_udata = 0;
598         ev_q->ev_handler = 0;
599 }
600
601 static void link_uctlr_ectlr(struct uth_sleep_ctlr *uctlr,
602                              struct evq_wakeup_ctlr *ectlr,
603                              struct evq_wait_link *link)
604 {
605         /* No lock needed for the uctlr; we're the only one modifying evqs */
606         link->uth_ctlr = uctlr;
607         TAILQ_INSERT_HEAD(&uctlr->evqs, link, link_uth);
608         /* Once we add ourselves to the ectrl list, we could start getting poked */
609         link->evq_ctlr = ectlr;
610         spin_pdr_lock(&ectlr->lock);
611         TAILQ_INSERT_HEAD(&ectlr->waiters, link, link_evq);
612         spin_pdr_unlock(&ectlr->lock);
613 }
614
615 /* Disconnects us from a wakeup controller.
616  *
617  * Our evq handlers wake up *all* uthreads that are waiting for activity
618  * (broadcast).  It's a tradeoff.  If the list of uthreads is long, then it is
619  * wasted effort.  An alternative is to wake up exactly one, with slightly
620  * greater overheads.  In the exactly-one case, multiple handlers could wake
621  * this uth up at once, but we can only extract one message.  If we do the
622  * single wake up, then when we detach from an ectlr, we need to peak in the
623  * mbox to see if it is not empty, and conditionally run its handler again, such
624  * that no uthread sits on a ectlr that has activity/pending messages (in
625  * essence, level triggered). */
626 static void unlink_ectlr(struct evq_wait_link *link)
627 {
628         struct evq_wakeup_ctlr *ectlr = link->evq_ctlr;
629         spin_pdr_lock(&ectlr->lock);
630         TAILQ_REMOVE(&ectlr->waiters, link, link_evq);
631         spin_pdr_unlock(&ectlr->lock);
632 }
633
634 /* Helper: polls all evqs once and extracts the first message available.  The
635  * message is copied into ev_msg, and the evq with the activity is copied into
636  * which_evq (if it is non-zero).  Returns TRUE on success. */
637 static bool extract_evqs_msg(struct event_queue *evqs[], size_t nr_evqs,
638                              struct event_msg *ev_msg,
639                              struct event_queue **which_evq)
640 {
641         struct event_queue *evq_i;
642         bool ret = FALSE;
643         /* We need to have notifs disabled when extracting messages from some
644          * mboxes.  Many mboxes have some form of busy waiting between consumers
645          * (userspace).  If we're just a uthread, we could wind up on a runqueue
646          * somewhere while someone else spins, possibly in VC ctx. */
647         uth_disable_notifs();
648         for (int i = 0; i < nr_evqs; i++) {
649                 evq_i = evqs[i];
650                 if (extract_one_mbox_msg(evq_i->ev_mbox, ev_msg)) {
651                         if (which_evq)
652                                 *which_evq = evq_i;
653                         ret = TRUE;
654                         break;
655                 }
656         }
657         uth_enable_notifs();
658         return ret;
659 }
660
661 /* Yield callback */
662 static void __uth_blockon_evq_cb(struct uthread *uth, void *arg)
663 {
664         struct uth_sleep_ctlr *uctlr = arg;
665         uthread_has_blocked(uth, UTH_EXT_BLK_EVENTQ);
666         cmb();  /* actually block before saying 'blocked' */
667         uctlr->blocked = TRUE;  /* can be woken up now */
668         wrmb(); /* write 'blocked' before read 'check_evqs' */
669         /* If someone set check_evqs, we should wake up.  We're competing with other
670          * wakers via poke (we may have already woken up!). */
671         if (uctlr->check_evqs)
672                 poke(&uctlr->poker, uctlr);
673         /* Once we say we're blocked, we could be woken up (possibly by our poke
674          * here) and the uthread could run on another core.  Holding this lock
675          * prevents the uthread from quickly returning and freeing the memory of
676          * uctrl before we have a chance to check_evqs or poke. */
677         spin_pdr_unlock(&uctlr->in_use);
678 }
679
680 /* Direct version, with *evqs[]. */
681 void uth_blockon_evqs_arr(struct event_msg *ev_msg,
682                           struct event_queue **which_evq,
683                           struct event_queue *evqs[], size_t nr_evqs)
684 {
685         struct uth_sleep_ctlr uctlr;
686         struct evq_wait_link linkage[nr_evqs];
687
688         /* Catch user mistakes.  If they lack a handler, they didn't attach.  They
689          * are probably using our evq_wakeup_handler, but they might have their own
690          * wrapper function. */
691         for (int i = 0; i < nr_evqs; i++)
692                 assert(evqs[i]->ev_handler);
693         /* Check for activity on the evqs before going through the hassle of
694          * sleeping.  ("check, signal, check again" pattern). */
695         if (extract_evqs_msg(evqs, nr_evqs, ev_msg, which_evq))
696                 return;
697         uth_sleep_ctlr_init(&uctlr, current_uthread);
698         memset(linkage, 0, sizeof(struct evq_wait_link) * nr_evqs);
699         for (int i = 0; i < nr_evqs; i++)
700                 link_uctlr_ectlr(&uctlr, (struct evq_wakeup_ctlr*)evqs[i]->ev_udata,
701                                  &linkage[i]);
702         /* Mesa-style sleep until we get a message.  Mesa helps a bit here, since we
703          * can just deregister from them all when we're done.  o/w it is tempting to
704          * have us deregister from *the* one in the handler and extract the message
705          * there; which can be tricky and harder to reason about. */
706         while (1) {
707                 /* We need to make sure only one 'version/ctx' of this thread is active
708                  * at a time.  Later on, we'll unlock in vcore ctx on the other side of
709                  * a yield.  We could restart from the yield, return, and free the uctlr
710                  * before that ctx has a chance to finish. */
711                 spin_pdr_lock(&uctlr.in_use);
712                 /* We're signed up.  We might already have been told to check the evqs,
713                  * or there could be messages still sitting in the evqs.  check_evqs is
714                  * only ever cleared here, and only ever set in evq handlers. */
715                 uctlr.check_evqs = FALSE;
716                 cmb();  /* look for messages after clearing check_evqs */
717                 if (extract_evqs_msg(evqs, nr_evqs, ev_msg, which_evq))
718                         break;
719                 uthread_yield(TRUE, __uth_blockon_evq_cb, &uctlr);
720         }
721         /* On the one hand, it's not necessary to unlock, since the memory will be
722          * freed.  But we do need to go through the process to turn on notifs and
723          * adjust the notif_disabled_depth for the case where we don't yield. */
724         spin_pdr_unlock(&uctlr.in_use);
725         for (int i = 0; i < nr_evqs; i++)
726                 unlink_ectlr(&linkage[i]);
727 }
728
729 /* ... are event_queue *s, nr_evqs of them.  This will block until it can
730  * extract some message from one of evqs.  The message will be placed in ev_msg,
731  * and the particular evq it extracted it from will be placed in which_evq, if
732  * which is non-zero. */
733 void uth_blockon_evqs(struct event_msg *ev_msg, struct event_queue **which_evq,
734                       size_t nr_evqs, ...)
735 {
736         struct event_queue *evqs[nr_evqs];
737         va_list va;
738         va_start(va, nr_evqs);
739         for (int i = 0; i < nr_evqs; i++)
740                 evqs[i] = va_arg(va, struct event_queue *);
741         va_end(va);
742         uth_blockon_evqs_arr(ev_msg, which_evq, evqs, nr_evqs);
743 }
744
745 /* ... are event_queue *s, nr_evqs of them.  This will attempt to extract some
746  * message from one of evqs.  The message will be placed in ev_msg, and the
747  * particular evq it extracted it from will be placed in which_evq.  Returns
748  * TRUE if it extracted a message. */
749 bool uth_check_evqs(struct event_msg *ev_msg, struct event_queue **which_evq,
750                     size_t nr_evqs, ...)
751 {
752         struct event_queue *evqs[nr_evqs];
753         va_list va;
754         va_start(va, nr_evqs);
755         for (int i = 0; i < nr_evqs; i++)
756                 evqs[i] = va_arg(va, struct event_queue *);
757         va_end(va);
758         return extract_evqs_msg(evqs, nr_evqs, ev_msg, which_evq);
759 }