Uthread vc_entry will spin on STEALING
[akaros.git] / user / parlib / event.c
1 /* Copyright (c) 2011 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Userspace utility functions for receiving events and notifications (IPIs).
6  * Some are higher level than others; just use what you need. */ 
7
8 #include <ros/event.h>
9 #include <ros/procdata.h>
10 #include <ucq.h>
11 #include <bitmask.h>
12 #include <vcore.h>
13 #include <stdlib.h>
14 #include <string.h>
15 #include <assert.h>
16 #include <errno.h>
17 #include <parlib.h>
18 #include <event.h>
19 #include <uthread.h>
20
21 /********* Event_q Setup / Registration  ***********/
22
23 /* Get event_qs via these interfaces, since eventually we'll want to either
24  * allocate from pinned memory or use some form of a slab allocator.  Also,
25  * these stitch up the big_q so its ev_mbox points to its internal mbox.  Never
26  * access the internal mbox directly.
27  *
28  * Raw ones need to have their UCQs initialized.  If you're making a lot of
29  * these, you can do one big mmap and init the ucqs on your own, which ought to
30  * perform better.
31  *
32  * Use the 'regular' one for big_qs if you don't want to worry about the ucq
33  * initalization */
34 struct event_queue *get_big_event_q_raw(void)
35 {
36         /* TODO: (PIN) should be pinned memory */
37         struct event_queue_big *big_q = malloc(sizeof(struct event_queue_big));
38         memset(big_q, 0, sizeof(struct event_queue_big));
39         big_q->ev_mbox = &big_q->ev_imbox;
40         return (struct event_queue*)big_q;
41 }
42
43 struct event_queue *get_big_event_q(void)
44 {
45         struct event_queue *big_q = get_big_event_q_raw();
46         /* uses the simpler, internally mmapping ucq_init() */
47         ucq_init(&big_q->ev_mbox->ev_msgs);
48         return big_q;
49 }
50
51 /* Give it up.  I don't recommend calling these unless you're sure the queues
52  * aren't in use (unregistered, etc). (TODO: consider some checks for this) */
53 void put_big_event_q_raw(struct event_queue *ev_q)
54 {
55         /* if we use something other than malloc, we'll need to be aware that ev_q
56          * is actually an event_queue_big.  One option is to use the flags, though
57          * this could be error prone. */
58         free(ev_q);
59 }
60
61 void put_big_event_q(struct event_queue *ev_q)
62 {
63         ucq_free_pgs(&ev_q->ev_mbox->ev_msgs);
64         put_big_event_q_raw(ev_q);
65 }
66
67 /* Need to point this event_q to an mbox - usually to a vcpd */
68 struct event_queue *get_event_q(void)
69 {
70         /* TODO: (PIN) should be pinned memory */
71         struct event_queue *ev_q = malloc(sizeof(struct event_queue));
72         memset(ev_q, 0, sizeof(struct event_queue));
73         return ev_q;
74 }
75
76 /* Gets a small ev_q, with ev_mbox pointing to the vcpd mbox of vcoreid */
77 struct event_queue *get_event_q_vcpd(uint32_t vcoreid)
78 {
79         struct event_queue *ev_q = get_event_q();
80         ev_q->ev_mbox = &__procdata.vcore_preempt_data[vcoreid].ev_mbox;
81         return ev_q;
82 }
83
84 void put_event_q(struct event_queue *ev_q)
85 {
86         /* if we use something other than malloc, we'll need to be aware that ev_q
87          * is not an event_queue_big. */
88         free(ev_q);
89 }
90
91 /* Sets ev_q to be the receiving end for kernel event ev_type */
92 void register_kevent_q(struct event_queue *ev_q, unsigned int ev_type)
93 {
94         __procdata.kernel_evts[ev_type] = ev_q;
95 }
96
97 /* Clears the event, returning an ev_q if there was one there.  You'll need to
98  * free it. */
99 struct event_queue *clear_kevent_q(unsigned int ev_type)
100 {
101         struct event_queue *ev_q = __procdata.kernel_evts[ev_type];
102         __procdata.kernel_evts[ev_type] = 0;
103         return ev_q;
104 }
105
106 /* Enables an IPI/event combo for ev_type sent to vcoreid's default mbox.  IPI
107  * if you want one or not.  This is the simplest thing applications may want,
108  * and shows how you can put the other event functions together to get similar
109  * things done. */
110 void enable_kevent(unsigned int ev_type, uint32_t vcoreid, int ev_flags)
111 {
112         struct event_queue *ev_q = get_event_q_vcpd(vcoreid);
113         ev_q->ev_flags = ev_flags;
114         ev_q->ev_vcore = vcoreid;
115         ev_q->ev_handler = 0;
116         wmb();  /* make sure ev_q is filled out before registering */
117         register_kevent_q(ev_q, ev_type);
118 }
119
120 /* Stop receiving the events (one could be on the way).  Caller needs to be
121  * careful, since the kernel might be sending an event to the ev_q.  Depending
122  * on the ev_q, it may be hard to know when it is done (for instance, if all
123  * syscalls you ever registered with the ev_q are done, then it would be okay).
124  * o/w, don't free it. */
125 struct event_queue *disable_kevent(unsigned int ev_type)
126 {
127         return clear_kevent_q(ev_type);
128 }
129
130 /********* Event Handling / Reception ***********/
131 /* Somewhat ghetto helper, for the lazy.  If all you care about is an event
132  * number, this will see if the event happened or not.  It will try for a
133  * message, but if there is none, it will go for a bit.  Note that multiple
134  * bit messages will turn into just one bit. */
135 unsigned int get_event_type(struct event_mbox *ev_mbox)
136 {
137         struct event_msg local_msg = {0};
138         /* UCQ returns 0 on success, so this will dequeue and return the type. */
139         if (!get_ucq_msg(&ev_mbox->ev_msgs, &local_msg)) {
140                 return local_msg.ev_type;
141         }
142         if (BITMASK_IS_CLEAR(&ev_mbox->ev_bitmap, MAX_NR_EVENT))
143                 return EV_NONE; /* aka, 0 */
144         for (int i = 0; i < MAX_NR_EVENT; i++) {
145                 if (GET_BITMASK_BIT(ev_mbox->ev_bitmap, i)) {
146                         CLR_BITMASK_BIT_ATOMIC(ev_mbox->ev_bitmap, i);
147                         return i;
148                 }
149         }
150         return EV_NONE;
151 }
152
153 /* Actual Event Handling */
154
155 /* List of handlers, process-wide, that the 2LS should fill in.  They all must
156  * return (don't context switch to a u_thread) */
157 handle_event_t ev_handlers[MAX_NR_EVENT] = {[EV_EVENT] handle_ev_ev, 0};
158
159 /* Handles all the messages in the mbox, but not the single bits.  Returns the
160  * number handled. */
161 int handle_mbox_msgs(struct event_mbox *ev_mbox)
162 {
163         int retval = 0;
164         struct event_msg local_msg;
165         unsigned int ev_type;
166         uint32_t vcoreid = vcore_id();
167         /* Try to dequeue, dispatch whatever you get. */
168         while (!get_ucq_msg(&ev_mbox->ev_msgs, &local_msg)) {
169                 ev_type = local_msg.ev_type;
170                 printd("[event] UCQ (mbox %08p), ev_type: %d\n", ev_mbox, ev_type);
171                 if (ev_handlers[ev_type])
172                         ev_handlers[ev_type](&local_msg, ev_type);
173                 check_preempt_pending(vcoreid);
174                 retval++;
175         }
176         return retval;
177 }
178
179 /* Handle an mbox.  This is the receive-side processing of an event_queue.  It
180  * takes an ev_mbox, since the vcpd mbox isn't a regular ev_q.  For now, we
181  * check for preemptions between each event handler. */
182 static int handle_mbox(struct event_mbox *ev_mbox, unsigned int flags)
183 {
184         int retval = 0;
185         uint32_t vcoreid = vcore_id();
186         printd("[event] handling ev_mbox %08p on vcore %d\n", ev_mbox, vcore_id());
187         /* Handle full messages.  Will deal with bits later. */
188         retval = handle_mbox_msgs(ev_mbox);
189         /* Process all bits, if they requested NOMSG.  o/w, we'll skip the bitmask
190          * scan.
191          *
192          * TODO: if they have a flag saying "it's okay to overflow", then we'll want
193          * to check the bits regardless */
194         void bit_handler(unsigned int bit) {
195                 printd("[event] Bit: ev_type: %d\n", bit);
196                 if (ev_handlers[bit])
197                         ev_handlers[bit](0, bit);
198                 retval++;
199                 check_preempt_pending(vcoreid);
200                 /* Consider checking the queue for incoming messages while we're here */
201         }
202         if (flags & EVENT_NOMSG)
203                 BITMASK_FOREACH_SET(ev_mbox->ev_bitmap, MAX_NR_EVENT, bit_handler,
204                                     TRUE);
205         return retval;
206 }
207
208 /* The EV_EVENT handler - extract the ev_q from the message. */
209 void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type)
210 {
211         struct event_queue *ev_q;
212         /* EV_EVENT can't handle not having a message / being a bit.  If we got a
213          * bit message, it's a bug somewhere */
214         assert(ev_msg);
215         ev_q = ev_msg->ev_arg3;
216         /* Same deal, a null ev_q is probably a bug, or someone being a jackass */
217         assert(ev_q);
218         /* Clear pending, so we can start getting INDIRs and IPIs again.  We must
219          * set this before (compared to handle_events, then set it, then handle
220          * again), since there is no guarantee handle_event_q() will return.  If
221          * there is a pending preemption, the vcore quickly yields and will deal
222          * with the remaining events in the future - meaning it won't return to
223          * here. */
224         ev_q->ev_alert_pending = FALSE;
225         wmb();  /* don't let the pending write pass the signaling of an ev recv */
226         handle_event_q(ev_q);
227 }
228
229 /* 2LS will probably call this in vcore_entry and places where it wants to check
230  * for / handle events.  This will process all the events for the given vcore.
231  * Note, it probably should be the calling vcore you do this to...  Returns the
232  * number of events handled. */
233 int handle_events(uint32_t vcoreid)
234 {
235         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
236         /* TODO: EVENT_NOMSG checks could be painful.  we could either keep track of
237          * whether or not the 2LS has a NOMSG ev_q pointing to its vcpd, or have the
238          * kernel set another flag for "bits" */
239         return handle_mbox(&vcpd->ev_mbox, EVENT_NOMSG);
240 }
241
242 /* Handles the events on ev_q IAW the event_handlers[].  If the ev_q is
243  * application specific, then this will dispatch/handle based on its flags. */
244 void handle_event_q(struct event_queue *ev_q)
245 {
246         /* If the program wants to handle the ev_q on its own: */
247         if (ev_q->ev_flags & (EVENT_JUSTHANDLEIT | EVENT_THREAD)) {
248                 if (!ev_q->ev_handler) {
249                         printf("No ev_handler installed for ev_q %08p, aborting!\n", ev_q);
250                         return;
251                 }
252                 if (ev_q->ev_flags & EVENT_JUSTHANDLEIT) {
253                         /* Remember this can't block or page fault */
254                         ev_q->ev_handler(ev_q);
255                 } else if (ev_q->ev_flags & EVENT_THREAD) {
256                         /* 2LS sched op.  The 2LS can use an existing thread if it wants,
257                          * but do so inside spawn_thread() */
258                         if (sched_ops->spawn_thread)
259                                 sched_ops->spawn_thread((uintptr_t)ev_q->ev_handler, ev_q);
260                         else
261                                 printf("2LS can't spawn a thread for ev_q %08p\n", ev_q);
262                 }
263                 return;
264         }
265         printd("[event] handling ev_q %08p on vcore %d\n", ev_q, vcore_id());
266         handle_mbox(ev_q->ev_mbox, ev_q->ev_flags);
267 }