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