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