4fd8cc7f7208b034994d356380ef64a92669ebf0
[akaros.git] / kern / src / 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  * Kernel utility functions for sending events and notifications (IPIs) to
6  * processes. */
7
8 #include <ucq.h>
9 #include <bitmask.h>
10 #include <event.h>
11 #include <atomic.h>
12 #include <process.h>
13 #include <smp.h>
14 #include <umem.h>
15 #include <stdio.h>
16 #include <assert.h>
17 #include <pmap.h>
18 #include <schedule.h>
19
20 /* Userspace could give us a vcoreid that causes us to compute a vcpd that is
21  * outside procdata.  If we hit UWLIM, then we've gone farther than we should.
22  * We check the vcoreid, instead of the resulting address, to avoid issues like
23  * address wrap-around. */
24 static bool vcoreid_is_safe(uint32_t vcoreid)
25 {
26         /* MAX_NUM_VCORES == MAX_NUM_CPUS (check procinfo/procdata) */
27         return vcoreid < MAX_NUM_CPUS;
28 }
29
30 /* Note these three helpers return the user address of the mbox, not the KVA.
31  * Load current to access this, and it will work for any process. */
32 static struct event_mbox *get_vcpd_mbox_priv(uint32_t vcoreid)
33 {
34         return &__procdata.vcore_preempt_data[vcoreid].ev_mbox_private;
35 }
36
37 static struct event_mbox *get_vcpd_mbox_pub(uint32_t vcoreid)
38 {
39         return &__procdata.vcore_preempt_data[vcoreid].ev_mbox_public;
40 }
41
42 static struct event_mbox *get_vcpd_mbox(uint32_t vcoreid, int ev_flags)
43 {
44         if (ev_flags & EVENT_VCORE_PRIVATE)
45                 return get_vcpd_mbox_priv(vcoreid);
46         else
47                 return get_vcpd_mbox_pub(vcoreid);
48 }
49
50 /* Can we message the vcore?  (Will it check its messages).  Note this checks
51  * procdata via the user pointer. */
52 static bool can_msg_vcore(uint32_t vcoreid)
53 {
54         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
55         return vcpd->can_rcv_msg;
56 }
57
58 /* Says a vcore can be messaged.  Only call this once you are sure this is true
59  * (holding the proc_lock, etc). */
60 static void set_vcore_msgable(uint32_t vcoreid)
61 {
62         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
63         vcpd->can_rcv_msg = TRUE;
64 }
65
66 /* Posts a message to the mbox, subject to flags.  Feel free to send 0 for the
67  * flags if you don't want to give them the option of EVENT_NOMSG (which is what
68  * we do when sending an indirection event).  Make sure that if mbox is a user
69  * pointer, that you've checked it *and* have that processes address space
70  * loaded.  This can get called with a KVA for mbox. */
71 static void post_ev_msg(struct proc *p, struct event_mbox *mbox,
72                         struct event_msg *msg, int ev_flags)
73 {
74         printd("[kernel] Sending event type %d to mbox %08p\n", msg->ev_type, mbox);
75         /* Sanity check */
76         assert(p);
77         /* If they just want a bit (NOMSG), just set the bit */
78         if (ev_flags & EVENT_NOMSG) {
79                 SET_BITMASK_BIT_ATOMIC(mbox->ev_bitmap, msg->ev_type);
80                 wmb();
81                 mbox->ev_check_bits = TRUE;
82         } else {
83                 send_ucq_msg(&mbox->ev_msgs, p, msg);
84         }
85 }
86
87 /* Helper: use this when sending a message to a VCPD mbox.  It just posts to the
88  * ev_mbox and sets notif pending.  Note this uses a userspace address for the
89  * VCPD (though not a user's pointer). */
90 static void post_vc_msg(struct proc *p, uint32_t vcoreid,
91                         struct event_mbox *ev_mbox, struct event_msg *ev_msg,
92                         int ev_flags)
93 {
94         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
95         post_ev_msg(p, ev_mbox, ev_msg, ev_flags);
96         /* Set notif pending so userspace doesn't miss the message while yielding */
97         wmb(); /* Ensure ev_msg write is before notif_pending */
98         /* proc_notify() also sets this, but the ev_q might not have requested an
99          * IPI, so we have to do it here too. */
100         vcpd->notif_pending = TRUE;
101 }
102
103 /* Helper: will IPI / proc_notify if the flags say so.  We also check to make
104  * sure it is mapped (slight optimization) */
105 static void try_notify(struct proc *p, uint32_t vcoreid, int ev_flags)
106 {
107         if ((ev_flags & EVENT_IPI) && vcore_is_mapped(p, vcoreid))
108                 proc_notify(p, vcoreid);
109 }
110
111 /* Helper: sends the message and an optional IPI to the vcore.  Sends to the
112  * public mbox.  This is meant for spammy messages. */
113 static void spam_vcore(struct proc *p, uint32_t vcoreid,
114                        struct event_msg *ev_msg, int ev_flags)
115 {
116         post_vc_msg(p, vcoreid, get_vcpd_mbox_pub(vcoreid), ev_msg, ev_flags);
117         try_notify(p, vcoreid, ev_flags);
118 }
119
120 /* Attempts to message a vcore that may or may not have 'can_rcv_msg' set.  If
121  * so, we'll post the message and the message will eventually get dealt with
122  * (when the vcore runs or when it is preempte-recovered). */
123 static bool try_spam_vcore(struct proc *p, uint32_t vcoreid,
124                            struct event_msg *ev_msg, int ev_flags)
125 {
126         /* Not sure if we can or not, so check before spamming.  Technically, the
127          * only critical part is that we __alert, then check can_alert. */
128         if (can_msg_vcore(vcoreid)) {
129                 spam_vcore(p, vcoreid, ev_msg, ev_flags);
130                 wrmb(); /* prev write (notif_pending) must come before following reads*/
131                 if (can_msg_vcore(vcoreid))
132                         return TRUE;
133         }
134         return FALSE;
135 }
136
137 /* Helper: will try to message (INDIR/IPI) a list member (lists of vcores).  We
138  * use this on the online and bulk_preempted vcore lists.  If this succeeds in
139  * alerting a vcore on the list, it'll return TRUE.  We need to be careful here,
140  * since we're reading a list that could be concurrently modified.  The
141  * important thing is that we can always fail if we're unsure (such as with
142  * lists being temporarily empty).  The caller will be able to deal with it via
143  * the ultimate fallback. */
144 static bool spam_list_member(struct vcore_tailq *list, struct proc *p,
145                              struct event_msg *ev_msg, int ev_flags)
146 {
147         struct vcore *vc, *vc_first;
148         uint32_t vcoreid;
149         int loops = 0;
150         vc = TAILQ_FIRST(list);
151         /* If the list appears empty, we'll bail out (failing) after the loop. */
152         while (vc) {
153                 vcoreid = vcore2vcoreid(p, vc);
154                 /* post the alert.  Not using the try_spam_vcore() helper since I want
155                  * something more customized for the lists. */
156                 spam_vcore(p, vcoreid, ev_msg, ev_flags);
157                 wrmb(); /* prev write (notif_pending) must come before following reads*/
158                 /* if they are still alertable after we sent the msg, then they'll get
159                  * it before yielding (racing with userspace yield here).  This check is
160                  * not as critical as the next one, but will allow us to alert vcores
161                  * that happen to concurrently be moved from the active to the
162                  * bulk_preempt list. */
163                 if (can_msg_vcore(vcoreid))
164                         return TRUE;
165                 /* As a backup, if they are still the first on the list, then they are
166                  * still going to get the message.  For the online list, proc_yield()
167                  * will return them to userspace (where they will get the message)
168                  * because __alert_vcore() set notif_pending.  For the BP list, they
169                  * will either be turned on later, or have a preempt message sent about
170                  * their demise.
171                  *
172                  * We race on list membership (and not exclusively 'can_rcv_msg', so
173                  * that when it fails we can get a new vcore to try (or know WHP there
174                  * are none). */
175                 vc_first = TAILQ_FIRST(list);
176                 if (vc == vc_first)
177                         return TRUE;
178                 /* At this point, the list has changed and the vcore we tried yielded,
179                  * so we try the *new* list head.  Track loops for sanity reasons. */
180                 if (loops++ > 10) {
181                         warn("Too many (%d) attempts to find a vcore, failing!", loops);
182                         return FALSE;   /* always safe to fail! */
183                 }
184                 /* Get set up for your attack run! */
185                 vc = vc_first;
186         }
187         return FALSE;
188 }
189
190 /* This makes sure ev_msg is sent to some vcore, preferring vcoreid.
191  *
192  * One of the goals of FALLBACK (and this func) is to allow processes to yield
193  * cores without fear of losing messages.  Even when yielding and getting
194  * preempted, if your message is spammed, it will get to some vcore.  If
195  * MUST_RUN is set, it'll get to a running vcore.  Messages that you send like
196  * this must be able to handle spurious reads, since more than one vcore is
197  * likely to get the message and handle it.
198  *
199  * We try the desired vcore, using 'can_rcv_msg'.  Failing that, we'll search
200  * the online and then the bulk_preempted lists.  These lists serve as a way to
201  * find likely messageable vcores.  spam_list_member() helps us with them,
202  * failing if anything seems to go wrong.  At which point we just lock and try
203  * to deal with things.  In that scenario, we most likely would need to lock
204  * anyway to wake up the process (was WAITING).
205  *
206  * One tricky thing with sending to the bulk_preempt list is that we may want to
207  * send a message about a (bulk) preemption to someone on that list.  This works
208  * since a given vcore that was preempted will be removed from that list before
209  * we try to send_event() (in theory, there isn't code that can send that event
210  * yet).  Someone else will get the event and wake up the preempted vcore. */
211 static void spam_public_msg(struct proc *p, struct event_msg *ev_msg,
212                                                         uint32_t vcoreid, int ev_flags)
213 {
214         struct vcore *vc;
215         /* First, try posting to the desired vcore (so long as we don't have to send
216          * it to a vcore that will run, like we do for preempt messages). */
217         if (!(ev_flags & EVENT_VCORE_MUST_RUN) &&
218            (try_spam_vcore(p, vcoreid, ev_msg, ev_flags)))
219                 return;
220         /* If the process is WAITING, let's just jump to the fallback */
221         if (p->state == PROC_WAITING)
222                 goto ultimate_fallback;
223         /* If we're here, the desired vcore is unreachable, but the process is
224          * probably RUNNING_M (online_vs) or RUNNABLE_M (bulk preempted or recently
225          * woken up), so we'll need to find another vcore. */
226         if (spam_list_member(&p->online_vcs, p, ev_msg, ev_flags))
227                 return;
228         if (spam_list_member(&p->bulk_preempted_vcs, p, ev_msg, ev_flags))
229                 return;
230         /* Last chance, let's check the head of the inactives.  It might be
231          * alertable (the kernel set it earlier due to an event, or it was a
232          * bulk_preempt that didn't restart), and we can avoid grabbing the
233          * proc_lock. */
234         vc = TAILQ_FIRST(&p->inactive_vcs);
235         if (vc) {       /* might be none in rare circumstances */
236                 if (try_spam_vcore(p, vcore2vcoreid(p, vc), ev_msg, ev_flags)) {
237                         /* Need to ensure the proc wakes up, but only if it was WAITING.
238                          * One way for this to happen is if a normal vcore was preempted
239                          * right as another vcore was yielding, and the preempted
240                          * message was sent after the last vcore yielded (which caused
241                          * us to be WAITING */
242                         if (p->state == PROC_WAITING) {
243                                 spin_lock(&p->proc_lock);
244                                 __proc_wakeup(p);       /* internally, this double-checks WAITING */
245                                 spin_unlock(&p->proc_lock);
246                                 ksched_proc_unblocked(p);
247                         }
248                         return;
249                 }
250         }
251 ultimate_fallback:
252         /* At this point, we can't find one.  This could be due to a (hopefully
253          * rare) weird yield/request storm, or more commonly because the lists were
254          * empty and the process is simply WAITING (yielded all of its vcores and is
255          * waiting on an event).  Time for the ultimate fallback: locking.  Note
256          * that when we __alert_vcore(), there is a chance we need to mmap, which
257          * grabs the mm_lock. */
258         spin_lock(&p->proc_lock);
259         if (p->state != PROC_WAITING) {
260                 /* We need to check the online and bulk_preempt lists again, now that we are
261                  * sure no one is messing with them.  If we're WAITING, we can skip
262                  * these (or assert they are empty!). */
263                 vc = TAILQ_FIRST(&p->online_vcs);
264                 if (vc) {
265                         /* there's an online vcore, so just alert it (we know it isn't going
266                          * anywhere), and return */
267                         spam_vcore(p, vcore2vcoreid(p, vc), ev_msg, ev_flags);
268                         spin_unlock(&p->proc_lock);
269                         return;
270                 }
271                 vc = TAILQ_FIRST(&p->bulk_preempted_vcs);
272                 if (vc) {
273                         /* the process is bulk preempted, similar deal to above */
274                         spam_vcore(p, vcore2vcoreid(p, vc), ev_msg, ev_flags);
275                         spin_unlock(&p->proc_lock);
276                         return;
277                 }
278         }
279         /* At this point, we're sure all vcores are yielded, though we might not be
280          * WAITING.  Post to the first on the inactive list (which is the one that
281          * will definitely be woken up) */
282         vc = TAILQ_FIRST(&p->inactive_vcs);
283         assert(vc);
284         spam_vcore(p, vcore2vcoreid(p, vc), ev_msg, ev_flags);
285         /* Set the vcore's alertable flag, to short circuit our last ditch effort
286          * above */
287         set_vcore_msgable(vcore2vcoreid(p, vc));
288         /* The first event to catch the process with no online/bp vcores will need
289          * to wake it up.  (We could be RUNNABLE_M here if another event already woke
290          * us.) and we didn't get lucky with the penultimate fallback.
291          * __proc_wakeup() will check for WAITING. */
292         __proc_wakeup(p);
293         spin_unlock(&p->proc_lock);
294         ksched_proc_unblocked(p);
295         return;
296 }
297
298 /* Helper: sends an indirection event for an ev_q, preferring vcoreid */
299 static void send_indir(struct proc *p, struct event_queue *ev_q,
300                        uint32_t vcoreid)
301 {
302         struct event_msg local_msg = {0};
303         /* If an alert is already pending and they don't want repeats, just return.
304          * One of the few uses of NOTHROTTLE will be for preempt_msg ev_qs.  Ex: an
305          * INDIR was already sent to the preempted vcore, then alert throttling
306          * would stop another vcore from getting the message about the original
307          * vcore. */
308         if (!(ev_q->ev_flags & EVENT_NOTHROTTLE) && (ev_q->ev_alert_pending))
309                 return;
310         /* We'll eventually get an INDIR through, so don't send any more til
311          * userspace toggles this.  Regardless of other writers to this flag, we
312          * eventually send an alert that causes userspace to turn throttling off
313          * again (before handling all of the ev_q's events).
314          *
315          * This will also squelch IPIs, since there's no reason to send the IPI if
316          * the INDIR is still un-acknowledged.  The vcore is either in vcore
317          * context, attempting to deal with the INDIR, or offline.  This statement
318          * is probably true. */
319         ev_q->ev_alert_pending = TRUE;
320         wmb();  /* force this write to happen before any event writes */
321         local_msg.ev_type = EV_EVENT;
322         local_msg.ev_arg3 = ev_q;
323         /* Don't care about FALLBACK, just send and be done with it.  TODO:
324          * considering getting rid of FALLBACK as an option and making it mandatory
325          * when you want an INDIR.  Having trouble thinking of when you'd want an
326          * INDIR but not a FALLBACK. */
327         if (!(ev_q->ev_flags & EVENT_FALLBACK)) {
328                 printk("[kernel] INDIR requested without FALLBACK, prob a bug.\n");
329                 spam_vcore(p, vcoreid, &local_msg, ev_q->ev_flags);
330                 return;
331         }
332         /* At this point, we actually want to send an INDIR (with FALLBACK).
333          * This will guarantee the message makes it to some vcore.  For flags, we
334          * only want to send flags relevant to spamming messages. */
335         spam_public_msg(p, &local_msg, vcoreid, ev_q->ev_flags & EVENT_SPAM_FLAGS);
336 }
337
338 /* Send an event to ev_q, based on the parameters in ev_q's flag.  We don't
339  * accept null ev_qs, since the caller ought to be checking before bothering to
340  * make a msg and send it to the event_q.  Vcoreid is who the kernel thinks the
341  * message ought to go to (for IPIs).  Appropriate for things like
342  * EV_PREEMPT_PENDING, where we tell the affected vcore.  To have the message go
343  * where the kernel suggests, set EVENT_VCORE_APPRO(priate). */
344 void send_event(struct proc *p, struct event_queue *ev_q, struct event_msg *msg,
345                 uint32_t vcoreid)
346 {
347         struct proc *old_proc;
348         struct event_mbox *ev_mbox = 0;
349         assert(p);
350         printd("[kernel] sending msg to proc %08p, ev_q %08p\n", p, ev_q);
351         if (!ev_q) {
352                 warn("[kernel] Null ev_q - kernel code should check before sending!");
353                 return;
354         }
355         if (!is_user_rwaddr(ev_q, sizeof(struct event_queue))) {
356                 /* Ought to kill them, just warn for now */
357                 printk("[kernel] Illegal addr for ev_q\n");
358                 return;
359         }
360         /* ev_q is a user pointer, so we need to make sure we're in the right
361          * address space */
362         old_proc = switch_to(p);
363         /* If we're an _S, just spam vcore0, and wake up if necessary. */
364         if (!__proc_is_mcp(p)) {
365                 spam_vcore(p, 0, msg, ev_q->ev_flags);
366                 wrmb(); /* don't let the notif_pending write pass the state read */
367                 /* using the same pattern as in spam_public (which can have multiple
368                  * unblock callbacks */
369                 if (p->state == PROC_WAITING) {
370                         spin_lock(&p->proc_lock);
371                         __proc_wakeup(p);
372                         spin_unlock(&p->proc_lock);
373                         ksched_proc_unblocked(p);
374                 }
375                 goto out;
376         }
377         /* Get the vcoreid that we'll message (if appropriate).  For INDIR and
378          * SPAMMING, this is the first choice of a vcore, but other vcores might get
379          * it.  Common case is !APPRO and !ROUNDROBIN.  Note we are clobbering the
380          * vcoreid parameter. */
381         if (!(ev_q->ev_flags & EVENT_VCORE_APPRO))
382                 vcoreid = ev_q->ev_vcore;       /* use the ev_q's vcoreid */
383         /* Note that RR overwrites APPRO */
384         if (ev_q->ev_flags & EVENT_ROUNDROBIN) {
385                 /* Pick a vcore, round-robin style.  Assuming ev_vcore was the previous
386                  * one used.  Note that round-robin overrides the passed-in vcoreid.
387                  * Also note this may be 'wrong' if num_vcores changes. */
388                 vcoreid = (ev_q->ev_vcore + 1) % p->procinfo->num_vcores;
389                 ev_q->ev_vcore = vcoreid;
390         }
391         if (!vcoreid_is_safe(vcoreid)) {
392                 /* Ought to kill them, just warn for now */
393                 printk("[kernel] Vcoreid %d unsafe! (too big?)\n", vcoreid);
394                 goto out;
395         }
396         /* If we're a SPAM_PUBLIC, they just want us to spam the message.  Note we
397          * don't care about the mbox, since it'll go to VCPD public mboxes, and
398          * we'll prefer to send it to whatever vcoreid we determined at this point
399          * (via APPRO or whatever). */
400         if (ev_q->ev_flags & EVENT_SPAM_PUBLIC) {
401                 spam_public_msg(p, msg, vcoreid, ev_q->ev_flags & EVENT_SPAM_FLAGS);
402                 goto out;
403         }
404         /* We aren't spamming and we know the default vcore, and now we need to
405          * figure out which mbox to use.  If they provided an mbox, we'll use it.
406          * If not, we'll use a VCPD mbox (public or private, depending on the
407          * flags). */
408         ev_mbox = ev_q->ev_mbox;
409         if (!ev_mbox)
410                 ev_mbox = get_vcpd_mbox(vcoreid, ev_q->ev_flags);
411         /* At this point, we ought to have the right mbox to send the msg to, and
412          * which vcore to alert (IPI/INDIR) (if applicable).  The mbox could be the
413          * vcore's vcpd ev_mbox. */
414         if (!ev_mbox) {
415                 /* This shouldn't happen any more, this is more for sanity's sake */
416                 warn("[kernel] ought to have an mbox by now!");
417                 goto out;
418         }
419         /* Even if we're using an mbox in procdata (VCPD), we want a user pointer */
420         if (!is_user_rwaddr(ev_mbox, sizeof(struct event_mbox))) {
421                 /* Ought to kill them, just warn for now */
422                 printk("[kernel] Illegal addr for ev_mbox\n");
423                 goto out;
424         }
425         /* We used to support no msgs, but quit being lazy and send a 'msg'.  If the
426          * ev_q is a NOMSG, we won't actually memcpy or anything, it'll just be a
427          * vehicle for sending the ev_type. */
428         assert(msg);
429         post_ev_msg(p, ev_mbox, msg, ev_q->ev_flags);
430         wmb();  /* ensure ev_msg write is before alerting the vcore */
431         /* Prod/alert a vcore with an IPI or INDIR, if desired.  INDIR will also
432          * call try_notify (IPI) later */
433         if (ev_q->ev_flags & EVENT_INDIR) {
434                 send_indir(p, ev_q, vcoreid);
435         } else {
436                 /* they may want an IPI despite not wanting an INDIR */
437                 try_notify(p, vcoreid, ev_q->ev_flags);
438         }
439         /* Fall through */
440 out:
441         /* Return to the old address space. */
442         switch_back(p, old_proc);
443 }
444
445 /* Send an event for the kernel event ev_num.  These are the "one sided" kernel
446  * initiated events, that require a lookup of the ev_q in procdata.  This is
447  * roughly equivalent to the old "proc_notify()" */
448 void send_kernel_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid)
449 {
450         uint16_t ev_num = msg->ev_type;
451         assert(ev_num < MAX_NR_EVENT);          /* events start at 0 */
452         struct event_queue *ev_q = p->procdata->kernel_evts[ev_num];
453         /* linux would put a rmb_depends() here too, i think. */
454         if (ev_q)
455                 send_event(p, ev_q, msg, vcoreid);
456 }
457
458 /* Writes the msg to the vcpd mbox of the vcore.  If you want the private mbox,
459  * send in the ev_flag EVENT_VCORE_PRIVATE.  If not, the message could
460  * be received by other vcores if the given vcore is offline/preempted/etc.
461  * Whatever other flags you pass in will get sent to post_ev_msg.  Currently,
462  * the only one that will get looked at is NO_MSG (set a bit).
463  *
464  * This needs to load current (switch_to), but doesn't need to care about what
465  * the process wants.  Note this isn't commonly used - just the monitor and
466  * sys_self_notify(). */
467 void post_vcore_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid,
468                       int ev_flags)
469 {
470         /* Need to set p as current to post the event */
471         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
472         struct proc *old_proc = switch_to(p);
473         /* *ev_mbox is the user address of the vcpd mbox */
474         post_vc_msg(p, vcoreid, get_vcpd_mbox(vcoreid, ev_flags), msg, ev_flags);
475         switch_back(p, old_proc);
476 }