Fixes bug with current in send_event()
[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 <ros/bcq.h>
9 #include <arch/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
18 /* Note this returns the KVA of the mbox, not the user one. */
19 static struct event_mbox *get_proc_ev_mbox(struct proc *p, uint32_t vcoreid)
20 {
21         return &p->procdata->vcore_preempt_data[vcoreid].ev_mbox;
22 }
23
24 /* Posts a message to the mbox, subject to flags.  Feel free to send 0 for the
25  * flags if you don't want to give them the option of EVENT_NOMSG (which is what
26  * we do when sending an indirection event).  Make sure that if mbox is a user
27  * pointer, that you've checked it *and* have that processes address space
28  * loaded.  This can get called with a KVA for mbox. */
29 static void post_ev_msg(struct event_mbox *mbox, struct event_msg *msg,
30                         int ev_flags)
31 {
32         printd("Sending event type %d\n", msg->ev_type);
33         /* Sanity check */
34         if (is_user_rwaddr(mbox))
35                 assert(current);
36         /* If they just want a bit (NOMSG), just set the bit */
37         if (ev_flags & EVENT_NOMSG) {
38                 SET_BITMASK_BIT_ATOMIC(mbox->ev_bitmap, msg->ev_type);
39         } else {
40                 /* Enqueue returns 0 on success.  On failure, set a bit. */
41                 if (bcq_enqueue(&mbox->ev_msgs, msg, NR_BCQ_EVENTS, NR_BCQ_EV_LOOPS)) {
42                         atomic_inc((atomic_t)&mbox->ev_overflows); // careful here
43                         SET_BITMASK_BIT_ATOMIC(mbox->ev_bitmap, msg->ev_type);
44                         /* Catch "lots" of overflows that aren't acknowledged */
45                         if (mbox->ev_overflows > 10000)
46                                 warn("proc %d has way too many overflows", current->pid);
47                 }
48         }
49 }
50
51 /* Send an event to ev_q, based on the parameters in ev_q's flag.  We don't
52  * accept null ev_qs, since the caller ought to be checking before bothering to
53  * make a msg and send it to the event_q.  Vcoreid is who the kernel thinks the
54  * message ought to go to (for IPIs).  Appropriate for things like
55  * EV_PREEMPT_PENDING, where we tell the affected vcore.  To have the message go
56  * where the kernel suggests, set EVENT_VCORE_APPRO(priate). */
57 void send_event(struct proc *p, struct event_queue *ev_q, struct event_msg *msg,
58                 uint32_t vcoreid)
59 {
60         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
61         struct proc *old_proc = pcpui->cur_proc;        /* uncounted ref */
62         struct event_mbox *ev_mbox, *vcore_mbox;
63         struct event_msg local_msg = {0};
64         assert(p);
65         if (!ev_q) {
66                 warn("[kernel] Null ev_q - kernel code should check before sending!");
67                 return;
68         }
69         if (!is_user_rwaddr(ev_q)) {
70                 /* Ought to kill them, just warn for now */
71                 warn("[kernel] Illegal addr for ev_q");
72                 return;
73         }
74         /* ev_q can be a user pointer (not in procdata), so we need to make sure
75          * we're in the right address space */
76         if (old_proc != p) {
77                 /* Technically, we're storing a ref here, but our current ref on p is
78                  * sufficient (so long as we don't decref below) */
79                 pcpui->cur_proc = p;
80                 lcr3(p->env_cr3);
81         }
82         /* If we don't follow the kernel's advice, do what the process wants */
83         if (!(ev_q->ev_flags & EVENT_VCORE_APPRO))
84                 vcoreid = ev_q->ev_vcore;
85         /* Post the event.  Need to get the initial mbox (might be 0). */
86         ev_mbox = ev_q->ev_mbox;
87         /* Check on the style, which could affect our mbox selection.  Other styles
88          * would go here (or in similar functions we call to).  Important thing is
89          * we come out knowing which vcore to send to in the event of an IPI, and we
90          * know what mbox to post to. */
91         if (ev_q->ev_flags & EVENT_ROUNDROBIN) {
92                 /* Pick a vcore, and if we don't have a mbox yet, pick that vcore's
93                  * default mbox.  Assuming ev_vcore was the previous one used.  Note
94                  * that round-robin overrides the passed-in vcoreid. */
95                 vcoreid = (ev_q->ev_vcore + 1) % p->procinfo->num_vcores;
96                 ev_q->ev_vcore = vcoreid;
97                 if (!ev_mbox)
98                         ev_mbox = get_proc_ev_mbox(p, vcoreid);
99         }
100         /* At this point, we ought to have the right mbox to send the msg to, and
101          * which vcore to send an IPI to (if we send one). */
102         if (!ev_mbox) {
103                 /* this is a process error */
104                 warn("[kernel] ought to have an mbox by now!");
105                 goto out;
106         }
107         if (!is_user_rwaddr(ev_mbox)) {
108                 /* Ought to kill them, just warn for now */
109                 warn("[kernel] Illegal addr for ev_mbox");
110                 goto out;
111         }
112         /* We used to support no msgs, but quit being lazy and send a msg */
113         assert(msg);
114         post_ev_msg(ev_mbox, msg, ev_q->ev_flags);
115         /* Optional IPIs */
116         if (ev_q->ev_flags & EVENT_IPI) {
117                 /* if the mbox we sent to isn't the default one, we need to send the
118                  * vcore an ev_q indirection event */
119                 vcore_mbox = get_proc_ev_mbox(p, vcoreid);
120                 if (!uva_is_kva(p, ev_mbox, vcore_mbox)) {
121                         /* it is tempting to send_kernel_event(), using the ev_q for that
122                          * event, but that is inappropriate here, since we are sending to a
123                          * specific vcore */
124                         local_msg.ev_type = EV_EVENT;
125                         local_msg.ev_arg3 = ev_q;
126                         post_ev_msg(vcore_mbox, &local_msg, 0);
127                 }
128                 proc_notify(p, vcoreid);
129         }
130 out:
131         /* Return to the old address space.  We switched to p in the first place if
132          * it wasn't the same as the original current (old_proc). */
133         if (old_proc != p) {
134                 pcpui->cur_proc = old_proc;
135                 if (old_proc)
136                         lcr3(old_proc->env_cr3);
137         }
138 }
139
140 /* Send an event for the kernel event ev_num.  These are the "one sided" kernel
141  * initiated events, that require a lookup of the ev_q in procdata.  This is
142  * roughly equivalent to the old "proc_notify()" */
143 void send_kernel_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid)
144 {
145         uint16_t ev_num = msg->ev_type;
146         assert(ev_num < MAX_NR_EVENT);          /* events start at 0 */
147         struct event_queue *ev_q = p->procdata->kernel_evts[ev_num];
148         if (ev_q)
149                 send_event(p, ev_q, msg, vcoreid);
150 }
151
152 /* Writes the msg to the vcpd/default mbox of the vcore.  Doesn't need to check
153  * for current, or care about what the process wants. */
154 void post_vcore_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid)
155 {
156         struct event_mbox *vcore_mbox;
157         /* kernel address of the vcpd mbox */
158         vcore_mbox = get_proc_ev_mbox(p, vcoreid);
159         post_ev_msg(vcore_mbox, msg, 0);                /* no chance for a NOMSG either */
160 }