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