9c1d5dbda69fa8ffd08006ec26904b1dc7da0f5d
[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, this
25  * stitches up the big_q so its ev_mbox points to its internal mbox.  Never
26  * access the internal mbox directly. */
27 struct event_queue *get_big_event_q(void)
28 {
29         /* TODO: (PIN) should be pinned memory */
30         struct event_queue_big *big_q = malloc(sizeof(struct event_queue_big));
31         memset(big_q, 0, sizeof(struct event_queue_big));
32         big_q->ev_mbox = &big_q->ev_imbox;
33         return (struct event_queue*)big_q;
34 }
35
36 /* Give it up */
37 void put_big_event_q(struct event_queue *ev_q)
38 {
39         /* if we use something other than malloc, we'll need to be aware that ev_q
40          * is actually an event_queue_big.  One option is to use the flags, though
41          * this could be error prone. */
42         free(ev_q);
43 }
44
45 /* Need to point this event_q to an mbox - usually to a vcpd */
46 struct event_queue *get_event_q(void)
47 {
48         /* TODO: (PIN) should be pinned memory */
49         struct event_queue *ev_q = malloc(sizeof(struct event_queue));
50         memset(ev_q, 0, sizeof(struct event_queue));
51         return ev_q;
52 }
53
54 /* Gets a small ev_q, with ev_mbox pointing to the vcpd mbox of vcoreid */
55 struct event_queue *get_event_q_vcpd(uint32_t vcoreid)
56 {
57         struct event_queue *ev_q = get_event_q();
58         ev_q->ev_mbox = &__procdata.vcore_preempt_data[vcoreid].ev_mbox;
59         return ev_q;
60 }
61
62 void put_event_q(struct event_queue *ev_q)
63 {
64         /* if we use something other than malloc, we'll need to be aware that ev_q
65          * is actually an event_queue_big. */
66         free(ev_q);
67 }
68
69 /* Sets ev_q to be the receiving end for kernel event ev_type */
70 void register_kevent_q(struct event_queue *ev_q, unsigned int ev_type)
71 {
72         __procdata.kernel_evts[ev_type] = ev_q;
73 }
74
75 /* Clears the event, returning an ev_q if there was one there.  You'll need to
76  * free it. */
77 struct event_queue *clear_kevent_q(unsigned int ev_type)
78 {
79         struct event_queue *ev_q = __procdata.kernel_evts[ev_type];
80         __procdata.kernel_evts[ev_type] = 0;
81         return ev_q;
82 }
83
84 /* Enables an IPI/event combo for ev_type sent to vcoreid's default mbox.  IPI
85  * if you want one or not.  This is the simplest thing applications may want,
86  * and shows how you can put the other event functions together to get similar
87  * things done. */
88 void enable_kevent(unsigned int ev_type, uint32_t vcoreid, int ev_flags)
89 {
90         struct event_queue *ev_q = get_event_q_vcpd(vcoreid);
91         ev_q->ev_flags = ev_flags;
92         ev_q->ev_vcore = vcoreid;
93         ev_q->ev_handler = 0;
94         register_kevent_q(ev_q, ev_type);
95 }
96
97 /* Stop receiving the events (one could be on the way) */
98 void disable_kevent(unsigned int ev_type)
99 {
100         struct event_queue *ev_q = clear_kevent_q(ev_type);
101         if (ev_q)
102                 put_event_q(ev_q);
103         else
104                 printf("Tried to disable but no event_q loaded on ev_type %d", ev_type);
105 }
106
107 /********* Event Handling / Reception ***********/
108 /* Somewhat ghetto helper, for the lazy.  If all you care about is an event
109  * number, this will see if the event happened or not.  It will try for a
110  * message, but if there is none, it will go for a bit.  Note that multiple
111  * bit messages will turn into just one bit. */
112 unsigned int get_event_type(struct event_mbox *ev_mbox)
113 {
114         struct event_msg local_msg = {0};
115         /* UCQ returns 0 on success, so this will dequeue and return the type. */
116         if (!get_ucq_msg(&ev_mbox->ev_msgs, &local_msg)) {
117                 return local_msg.ev_type;
118         }
119         if (BITMASK_IS_CLEAR(&ev_mbox->ev_bitmap, MAX_NR_EVENT))
120                 return EV_NONE; /* aka, 0 */
121         for (int i = 0; i < MAX_NR_EVENT; i++) {
122                 if (GET_BITMASK_BIT(ev_mbox->ev_bitmap, i)) {
123                         CLR_BITMASK_BIT_ATOMIC(ev_mbox->ev_bitmap, i);
124                         return i;
125                 }
126         }
127         return EV_NONE;
128 }
129
130 /* Actual Event Handling */
131
132 /* List of handlers, process-wide, that the 2LS should fill in.  They all must
133  * return (don't context switch to a u_thread) */
134 handle_event_t ev_handlers[MAX_NR_EVENT] = {[EV_EVENT] handle_ev_ev, 0};
135
136 /* Handles all the messages in the mbox, but not the single bits.  Returns the
137  * number handled. */
138 int handle_mbox_msgs(struct event_mbox *ev_mbox)
139 {
140         int retval = 0;
141         struct event_msg local_msg;
142         unsigned int ev_type;
143         uint32_t vcoreid = vcore_id();
144         /* Try to dequeue, dispatch whatever you get. */
145         while (!get_ucq_msg(&ev_mbox->ev_msgs, &local_msg)) {
146                 ev_type = local_msg.ev_type;
147                 printd("UCQ: ev_type: %d\n", ev_type);
148                 if (ev_handlers[ev_type])
149                         ev_handlers[ev_type](&local_msg, ev_type);
150                 check_preempt_pending(vcoreid);
151                 retval++;
152         }
153         return retval;
154 }
155
156 /* Handle an mbox.  This is the receive-side processing of an event_queue.  It
157  * takes an ev_mbox, since the vcpd mbox isn't a regular ev_q.  For now, we
158  * check for preemptions between each event handler. */
159 static int handle_mbox(struct event_mbox *ev_mbox, unsigned int flags)
160 {
161         int retval = 0;
162         uint32_t vcoreid = vcore_id();
163
164         /* Handle full messages.  Will deal with bits later. */
165         retval = handle_mbox_msgs(ev_mbox);
166
167         /* Process all bits, if they requested NOMSG.  o/w, we'll skip the bitmask
168          * scan.
169          *
170          * TODO: if they have a flag saying "it's okay to overflow", then we'll want
171          * to check the bits regardless */
172         void bit_handler(unsigned int bit) {
173                 printd("Bit: ev_type: %d\n", bit);
174                 cmb();
175                 if (ev_handlers[bit])
176                         ev_handlers[bit](0, bit);
177                 retval++;
178                 check_preempt_pending(vcoreid);
179                 /* Consider checking the queue for incoming messages while we're here */
180         }
181         if (flags & EVENT_NOMSG)
182                 BITMASK_FOREACH_SET(ev_mbox->ev_bitmap, MAX_NR_EVENT, bit_handler,
183                                     TRUE);
184         return retval;
185 }
186
187 /* The EV_EVENT handler - extract the ev_q from the message. */
188 void handle_ev_ev(struct event_msg *ev_msg, unsigned int ev_type)
189 {
190         struct event_queue *ev_q;
191         /* EV_EVENT can't handle not having a message / being a bit.  If we got a
192          * bit message, it's a bug somewhere */
193         assert(ev_msg);
194         ev_q = ev_msg->ev_arg3;
195         /* Same deal, a null ev_q is probably a bug, or someone being a jackass */
196         assert(ev_q);
197         handle_event_q(ev_q);
198 }
199
200 /* 2LS will probably call this in vcore_entry and places where it wants to check
201  * for / handle events.  This will process all the events for the given vcore.
202  * Note, it probably should be the calling vcore you do this to...  Returns the
203  * number of events handled. */
204 int handle_events(uint32_t vcoreid)
205 {
206         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
207         /* TODO: EVENT_NOMSG checks could be painful.  we could either keep track of
208          * whether or not the 2LS has a NOMSG ev_q pointing to its vcpd, or have the
209          * kernel set another flag for "bits" */
210         return handle_mbox(&vcpd->ev_mbox, EVENT_NOMSG);
211 }
212
213 /* Handles the events on ev_q IAW the event_handlers[].  If the ev_q is
214  * application specific, then this will dispatch/handle based on its flags. */
215 void handle_event_q(struct event_queue *ev_q)
216 {
217         /* If the program wants to handle the ev_q on its own: */
218         if (ev_q->ev_flags & (EVENT_JUSTHANDLEIT | EVENT_THREAD)) {
219                 if (!ev_q->ev_handler) {
220                         printf("No ev_handler installed for ev_q %08p, aborting!\n", ev_q);
221                         return;
222                 }
223                 if (ev_q->ev_flags & EVENT_JUSTHANDLEIT) {
224                         /* Remember this can't block or page fault */
225                         ev_q->ev_handler(ev_q);
226                 } else if (ev_q->ev_flags & EVENT_THREAD) {
227                         /* 2LS sched op.  The 2LS can use an existing thread if it wants,
228                          * but do so inside spawn_thread() */
229                         if (sched_ops->spawn_thread)
230                                 sched_ops->spawn_thread((uintptr_t)ev_q->ev_handler, ev_q);
231                         else
232                                 printf("2LS can't spawn a thread for ev_q %08p\n", ev_q);
233                 }
234                 return;
235         }
236         handle_mbox(ev_q->ev_mbox, ev_q->ev_flags);
237 }