Make the CXX be called ucb-akaros
[akaros.git] / user / parlib / event.c
index 04b27af..eb6b74c 100644 (file)
 #include <parlib.h>
 #include <event.h>
 #include <uthread.h>
+#include <spinlock.h>
+
+/* For remote VCPD mbox event handling */
+__thread bool __vc_handle_an_mbox = FALSE;
+__thread uint32_t __vc_rem_vcoreid;
 
 /********* Event_q Setup / Registration  ***********/
 
@@ -73,11 +78,16 @@ struct event_queue *get_event_q(void)
        return ev_q;
 }
 
-/* Gets a small ev_q, with ev_mbox pointing to the vcpd mbox of vcoreid */
-struct event_queue *get_event_q_vcpd(uint32_t vcoreid)
+/* Gets a small ev_q, with ev_mbox pointing to the vcpd mbox of vcoreid.  If
+ * ev_flags has EVENT_VCORE_PRIVATE set, it'll give you the private mbox.  o/w,
+ * you'll get the public one. */
+struct event_queue *get_event_q_vcpd(uint32_t vcoreid, int ev_flags)
 {
        struct event_queue *ev_q = get_event_q();
-       ev_q->ev_mbox = &__procdata.vcore_preempt_data[vcoreid].ev_mbox;
+       if (ev_flags & EVENT_VCORE_PRIVATE)
+               ev_q->ev_mbox = &vcpd_of(vcoreid)->ev_mbox_private;
+       else
+               ev_q->ev_mbox = &vcpd_of(vcoreid)->ev_mbox_public;
        return ev_q;
 }
 
@@ -104,12 +114,15 @@ struct event_queue *clear_kevent_q(unsigned int ev_type)
 }
 
 /* Enables an IPI/event combo for ev_type sent to vcoreid's default mbox.  IPI
- * if you want one or not.  This is the simplest thing applications may want,
- * and shows how you can put the other event functions together to get similar
- * things done. */
+ * if you want one or not.  If you want the event to go to the vcore private
+ * mbox (meaning no other core should ever handle it), send in
+ * EVENT_VCORE_PRIVATE with ev_flags.
+ *
+ * This is the simplest thing applications may want, and shows how you can put
+ * the other event functions together to get similar things done. */
 void enable_kevent(unsigned int ev_type, uint32_t vcoreid, int ev_flags)
 {
-       struct event_queue *ev_q = get_event_q_vcpd(vcoreid);
+       struct event_queue *ev_q = get_event_q_vcpd(vcoreid, ev_flags);
        ev_q->ev_flags = ev_flags;
        ev_q->ev_vcore = vcoreid;
        ev_q->ev_handler = 0;
@@ -152,63 +165,103 @@ unsigned int get_event_type(struct event_mbox *ev_mbox)
 
 /* Actual Event Handling */
 
-/* List of handlers, process-wide, that the 2LS should fill in.  They all must
- * return (don't context switch to a u_thread) */
-handle_event_t ev_handlers[MAX_NR_EVENT] = {[EV_EVENT] handle_ev_ev, 0};
+/* List of handler lists, process-wide.  They all must return (don't context
+ * switch to a u_thread) */
+struct ev_handler *ev_handlers[MAX_NR_EVENT] = {0};
+spinpdrlock_t ev_h_wlock = SPINPDR_INITIALIZER;
 
-/* Handles all the messages in the mbox, but not the single bits.  Returns the
- * number handled. */
-int handle_mbox_msgs(struct event_mbox *ev_mbox)
+int register_ev_handler(unsigned int ev_type, handle_event_t handler,
+                        void *data)
+{
+       struct ev_handler *new_h = malloc(sizeof(struct ev_handler));
+       if (!new_h)
+               return -1;
+       new_h->func = handler;
+       new_h->data = data;
+       spin_pdr_lock(&ev_h_wlock);
+       new_h->next = ev_handlers[ev_type];
+       wmb();  /* make sure new_h is done before publishing to readers */
+       ev_handlers[ev_type] = new_h;
+       spin_pdr_unlock(&ev_h_wlock);
+       return 0;
+}
+
+int deregister_ev_handler(unsigned int ev_type, handle_event_t handler,
+                          void *data)
+{
+       /* TODO: User-level RCU */
+       printf("Failed to dereg handler, not supported yet!\n");
+}
+
+static void run_ev_handlers(unsigned int ev_type, struct event_msg *ev_msg)
+{
+       struct ev_handler *handler;
+       /* TODO: RCU read lock */
+       handler = ev_handlers[ev_type];
+       while (handler) {
+               handler->func(ev_msg, ev_type, handler->data);
+               handler = handler->next;
+       }
+}
+
+/* Attempts to handle a message.  Returns 1 if we dequeued a msg, 0 o/w. */
+int handle_one_mbox_msg(struct event_mbox *ev_mbox)
 {
-       int retval = 0;
        struct event_msg local_msg;
        unsigned int ev_type;
-       uint32_t vcoreid = vcore_id();
-       /* Try to dequeue, dispatch whatever you get. */
-       while (!get_ucq_msg(&ev_mbox->ev_msgs, &local_msg)) {
-               ev_type = local_msg.ev_type;
-               printd("[event] UCQ (mbox %08p), ev_type: %d\n", ev_mbox, ev_type);
-               if (ev_handlers[ev_type])
-                       ev_handlers[ev_type](&local_msg, ev_type);
-               check_preempt_pending(vcoreid);
-               retval++;
-       }
-       return retval;
+       /* get_ucq returns 0 on success, -1 on empty */
+       if (get_ucq_msg(&ev_mbox->ev_msgs, &local_msg) == -1)
+               return 0;
+       ev_type = local_msg.ev_type;
+       assert(ev_type < MAX_NR_EVENT);
+       printd("[event] UCQ (mbox %08p), ev_type: %d\n", ev_mbox, ev_type);
+       run_ev_handlers(ev_type, &local_msg);
+       return 1;
 }
 
 /* Handle an mbox.  This is the receive-side processing of an event_queue.  It
- * takes an ev_mbox, since the vcpd mbox isn't a regular ev_q.  For now, we
- * check for preemptions between each event handler. */
-static int handle_mbox(struct event_mbox *ev_mbox, unsigned int flags)
+ * takes an ev_mbox, since the vcpd mbox isn't a regular ev_q.  Returns 1 if we
+ * handled something, 0 o/w. */
+int handle_mbox(struct event_mbox *ev_mbox)
 {
        int retval = 0;
        uint32_t vcoreid = vcore_id();
-
-       printd("[event] handling ev_mbox %08p on vcore %d\n", ev_mbox, vcore_id());
-       /* Handle full messages.  Will deal with bits later. */
-       retval = handle_mbox_msgs(ev_mbox);
-
-       /* Process all bits, if they requested NOMSG.  o/w, we'll skip the bitmask
-        * scan.
-        *
-        * TODO: if they have a flag saying "it's okay to overflow", then we'll want
-        * to check the bits regardless */
        void bit_handler(unsigned int bit) {
                printd("[event] Bit: ev_type: %d\n", bit);
-               if (ev_handlers[bit])
-                       ev_handlers[bit](0, bit);
-               retval++;
-               check_preempt_pending(vcoreid);
+               run_ev_handlers(bit, 0);
+               retval = 1;
                /* Consider checking the queue for incoming messages while we're here */
        }
-       if (flags & EVENT_NOMSG)
-               BITMASK_FOREACH_SET(ev_mbox->ev_bitmap, MAX_NR_EVENT, bit_handler,
-                                   TRUE);
+       printd("[event] handling ev_mbox %08p on vcore %d\n", ev_mbox, vcore_id());
+       /* Some stack-smashing bugs cause this to fail */
+       assert(ev_mbox);
+       /* Handle all full messages, tracking if we do at least one. */
+       while (handle_one_mbox_msg(ev_mbox))
+               retval = 1;
+       /* Process all bits, if the kernel tells us any bit is set.  We don't clear
+        * the flag til after we check everything, in case one of the handlers
+        * doesn't return.  After we clear it, we recheck. */
+       if (ev_mbox->ev_check_bits) {
+               do {
+                       ev_mbox->ev_check_bits = TRUE;  /* in case we don't return */
+                       cmb();
+                       BITMASK_FOREACH_SET(ev_mbox->ev_bitmap, MAX_NR_EVENT, bit_handler,
+                                           TRUE);
+                       ev_mbox->ev_check_bits = FALSE;
+                       wrmb(); /* check_bits written before we check for it being clear */
+               } while (!BITMASK_IS_CLEAR(ev_mbox->ev_bitmap, MAX_NR_EVENT));
+       }
        return retval;
 }
 
+/* Empty if the UCQ is empty and the bits don't need checked */
+bool mbox_is_empty(struct event_mbox *ev_mbox)
+{
+       return (ucq_is_empty(&ev_mbox->ev_msgs) && (!ev_mbox->ev_check_bits));
+}
+
 /* The EV_EVENT handler - extract the ev_q from the message. */
-void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type)
+void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type, void *data)
 {
        struct event_queue *ev_q;
        /* EV_EVENT can't handle not having a message / being a bit.  If we got a
@@ -228,17 +281,23 @@ void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type)
        handle_event_q(ev_q);
 }
 
-/* 2LS will probably call this in vcore_entry and places where it wants to check
- * for / handle events.  This will process all the events for the given vcore.
- * Note, it probably should be the calling vcore you do this to...  Returns the
- * number of events handled. */
+/* Handles VCPD events (public and private).  The kernel always sets
+ * notif_pending after posting a message to either public or private mailbox.
+ * When this returns, as far as we are concerned, notif_pending is FALSE.
+ * However, a concurrent kernel writer could have reset it to true.  This is
+ * fine; whenever we leave VC ctx we double check notif_pending.  Returns 1 or 2
+ * if we actually handled a message, 0 o/w.
+ *
+ * WARNING: this might not return and/or current_uthread may change. */
 int handle_events(uint32_t vcoreid)
 {
-       struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
-       /* TODO: EVENT_NOMSG checks could be painful.  we could either keep track of
-        * whether or not the 2LS has a NOMSG ev_q pointing to its vcpd, or have the
-        * kernel set another flag for "bits" */
-       return handle_mbox(&vcpd->ev_mbox, EVENT_NOMSG);
+       struct preempt_data *vcpd = vcpd_of(vcoreid);
+       int retval = 0;
+       vcpd->notif_pending = FALSE;
+       wrmb(); /* prevent future reads from happening before notif_p write */
+       retval += handle_mbox(&vcpd->ev_mbox_private);
+       retval += handle_mbox(&vcpd->ev_mbox_public);
+       return retval;
 }
 
 /* Handles the events on ev_q IAW the event_handlers[].  If the ev_q is
@@ -265,5 +324,133 @@ void handle_event_q(struct event_queue *ev_q)
                return;
        }
        printd("[event] handling ev_q %08p on vcore %d\n", ev_q, vcore_id());
-       handle_mbox(ev_q->ev_mbox, ev_q->ev_flags);
+       /* Raw ev_qs that haven't been connected to an mbox, user bug: */
+       assert(ev_q->ev_mbox);
+       handle_mbox(ev_q->ev_mbox);
+}
+
+/* Sends the calling vcore a message to its public mbox.  This is purposefully
+ * limited to just the calling vcore, since in future versions, we can send via
+ * ucqs directly (in many cases).  That will require the caller to be the
+ * vcoreid, due to some preemption recovery issues (another ucq poller is
+ * waiting on us when we got preempted, and we never up nr_cons). */
+void send_self_vc_msg(struct event_msg *ev_msg)
+{
+       // TODO: try to use UCQs (requires additional support)
+       /* ev_type actually gets ignored currently.  ev_msg is what matters if it is
+        * non-zero.  FALSE means it's going to the public mbox */
+       sys_self_notify(vcore_id(), ev_msg->ev_type, ev_msg, FALSE);
+}
+
+/* Helper: makes the current core handle a remote vcore's VCPD public mbox events.
+ *
+ * Both cases (whether we are handling someone else's already or not) use some
+ * method of telling our future self what to do.  When we aren't already
+ * handling it, we use TLS, and jump to vcore entry.  When we are already
+ * handling, then we send a message to ourself, which we deal with when we
+ * handle our own events (which is later in vcore entry).
+ *
+ * We need to reset the stack and deal with it in vcore entry to avoid recursing
+ * deeply and running off the transition stack.  (handler calling handle event).
+ *
+ * Note that we might not be the one that gets the message we send.  If we pull
+ * a sys_change_to, someone else might be polling our public message box.  All
+ * we're doing is making sure that we don't forget to check rem_vcoreid's mbox.
+ *
+ * Finally, note that this function might not return.  However, it'll handle the
+ * details related to vcpd mboxes, so you don't use the ev_might_not_return()
+ * helpers with this. */
+void handle_vcpd_mbox(uint32_t rem_vcoreid)
+{
+       uint32_t vcoreid = vcore_id();
+       struct preempt_data *vcpd = vcpd_of(vcoreid);
+       struct event_msg local_msg = {0};
+       assert(vcoreid != rem_vcoreid);                 /* this shouldn't happen */
+       /* If they are empty, then we're done */
+       if (mbox_is_empty(&vcpd_of(rem_vcoreid)->ev_mbox_public))
+               return;
+       if (__vc_handle_an_mbox) {
+               /* we might be already handling them, in which case, abort */
+               if (__vc_rem_vcoreid == rem_vcoreid)
+                       return;
+               /* Already handling message for someone, need to send ourselves a
+                * message to check rem_vcoreid, which we'll process later. */
+               local_msg.ev_type = EV_CHECK_MSGS;
+               local_msg.ev_arg2 = rem_vcoreid;        /* 32bit arg */
+               send_self_vc_msg(&local_msg);
+               return;
+       }
+       /* No return after here */
+       /* At this point, we aren't in the process of handling someone else's
+        * messages, so just tell our future self what to do */
+       __vc_handle_an_mbox = TRUE;
+       __vc_rem_vcoreid = rem_vcoreid;
+       /* Reset the stack and start over in vcore context */
+       set_stack_pointer((void*)vcpd->transition_stack);
+       vcore_entry();
+       assert(0);
+}
+
+/* Handle remote vcpd public mboxes, if that's what we want to do.  Call this
+ * from vcore entry, pairs with handle_vcpd_mbox(). */
+void try_handle_remote_mbox(void)
+{
+       if (__vc_handle_an_mbox) {
+               handle_mbox(&vcpd_of(__vc_rem_vcoreid)->ev_mbox_public);
+               /* only clear the flag when we have returned from handling messages.  if
+                * an event handler (like preempt_recover) doesn't return, we'll clear
+                * this flag elsewhere. (it's actually not a big deal if we don't). */
+               cmb();
+               __vc_handle_an_mbox = FALSE;
+       }
+}
+
+/* Event handler helpers */
+
+/* For event handlers that might not return, we need to call this before the
+ * command that might not return.  In the event we were handling a remote
+ * vcore's messages, it'll send ourselves a messages that we (or someone who
+ * polls us) will get so that someone finishes off that vcore's messages).
+ * Doesn't matter who does, so long as someone does.
+ *
+ * This returns whether or not we were handling someone's messages.  Pass the
+ * parameter to ev_we_returned() */
+bool ev_might_not_return(void)
+{
+       struct event_msg local_msg = {0};
+       bool were_handling_remotes = FALSE;
+       if (__vc_handle_an_mbox) {
+               /* slight chance we finished with their mbox (were on the last one) */
+               if (!mbox_is_empty(&vcpd_of(__vc_rem_vcoreid)->ev_mbox_public)) {
+                       /* But we aren't, so we'll need to send a message */
+                       local_msg.ev_type = EV_CHECK_MSGS;
+                       local_msg.ev_arg2 = __vc_rem_vcoreid;   /* 32bit arg */
+                       send_self_vc_msg(&local_msg);
+               }
+               /* Either way, we're not working on this one now.  Note this is more of
+                * an optimization - it'd be harmless (I think) to poll another vcore's
+                * pub mbox once when we pop up in vc_entry in the future */
+               __vc_handle_an_mbox = FALSE;
+               return TRUE;
+       }
+       return FALSE;
+}
+
+/* Call this when you return, paired up with ev_might_not_return().  If
+ * ev_might_not_return turned off uth_handle, we'll turn it back on. */
+void ev_we_returned(bool were_handling_remotes)
+{
+       if (were_handling_remotes)
+               __vc_handle_an_mbox = TRUE;
+}
+
+/* Debugging */
+void print_ev_msg(struct event_msg *msg)
+{
+       printf("MSG at %08p\n", msg);
+       printf("\ttype: %d\n", msg->ev_type);
+       printf("\targ1 (16): 0x%4x\n", msg->ev_arg1);
+       printf("\targ2 (32): 0x%8x\n", msg->ev_arg2);
+       printf("\targ3 (32): 0x%8x\n", msg->ev_arg3);
+       printf("\targ4 (64): 0x%16x\n", msg->ev_arg4);
 }