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