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