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