Replaces BCQs with UCQs (XCC)
[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 /* 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         struct proc *p = current;
36         printd("Sending event type %d\n", msg->ev_type);
37         /* Sanity check */
38         assert(p);
39         /* If they just want a bit (NOMSG), just set the bit */
40         if (ev_flags & EVENT_NOMSG) {
41                 SET_BITMASK_BIT_ATOMIC(mbox->ev_bitmap, msg->ev_type);
42         } else {
43                 send_ucq_msg(&mbox->ev_msgs, p, msg);
44         }
45 }
46
47 /* Send an event to ev_q, based on the parameters in ev_q's flag.  We don't
48  * accept null ev_qs, since the caller ought to be checking before bothering to
49  * make a msg and send it to the event_q.  Vcoreid is who the kernel thinks the
50  * message ought to go to (for IPIs).  Appropriate for things like
51  * EV_PREEMPT_PENDING, where we tell the affected vcore.  To have the message go
52  * where the kernel suggests, set EVENT_VCORE_APPRO(priate). */
53 void send_event(struct proc *p, struct event_queue *ev_q, struct event_msg *msg,
54                 uint32_t vcoreid)
55 {
56         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
57         struct proc *old_proc = pcpui->cur_proc;        /* uncounted ref */
58         struct event_mbox *ev_mbox = 0, *vcore_mbox;
59         struct event_msg local_msg = {0};
60         assert(p);
61         if (!ev_q) {
62                 warn("[kernel] Null ev_q - kernel code should check before sending!");
63                 return;
64         }
65         if (!is_user_rwaddr(ev_q, sizeof(struct event_queue))) {
66                 /* Ought to kill them, just warn for now */
67                 warn("[kernel] Illegal addr for ev_q");
68                 return;
69         }
70         /* ev_q is a user pointer, so we need to make sure we're in the right
71          * address space */
72         if (old_proc != p) {
73                 /* Technically, we're storing a ref here, but our current ref on p is
74                  * sufficient (so long as we don't decref below) */
75                 pcpui->cur_proc = p;
76                 lcr3(p->env_cr3);
77         }
78         /* Get the mbox and vcoreid */
79         /* If we're going with APPRO, we use the kernel's suggested vcore's ev_mbox.
80          * vcoreid is already what the kernel suggests. */
81         if (ev_q->ev_flags & EVENT_VCORE_APPRO) {
82                 ev_mbox = get_proc_ev_mbox(vcoreid);
83         } else {        /* common case */
84                 ev_mbox = ev_q->ev_mbox;
85                 vcoreid = ev_q->ev_vcore;
86         }
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(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).  The mbox could be the
102          * vcore's vcpd ev_mbox. */
103         if (!ev_mbox) {
104                 /* this is a process error */
105                 warn("[kernel] ought to have an mbox by now!");
106                 goto out;
107         }
108         /* Even if we're using an mbox in procdata (VCPD), we want a user pointer */
109         if (!is_user_rwaddr(ev_mbox, sizeof(struct event_mbox))) {
110                 /* Ought to kill them, just warn for now */
111                 warn("[kernel] Illegal addr for ev_mbox");
112                 goto out;
113         }
114         /* We used to support no msgs, but quit being lazy and send a 'msg'.  If the
115          * ev_q is a NOMSG, we won't actually memcpy or anything, it'll just be a
116          * vehicle for sending the ev_type. */
117         assert(msg);
118         post_ev_msg(ev_mbox, msg, ev_q->ev_flags);
119         /* Optional IPIs */
120         if (ev_q->ev_flags & EVENT_IPI) {
121                 /* if the mbox we sent to isn't the default one, we need to send the
122                  * vcore an ev_q indirection event */
123                 vcore_mbox = get_proc_ev_mbox(vcoreid);
124                 if (ev_mbox != vcore_mbox) {
125                         /* it is tempting to send_kernel_event(), using the ev_q for that
126                          * event, but that is inappropriate here, since we are sending to a
127                          * specific vcore */
128                         local_msg.ev_type = EV_EVENT;
129                         local_msg.ev_arg3 = ev_q;
130                         post_ev_msg(vcore_mbox, &local_msg, 0);
131                 }
132                 proc_notify(p, vcoreid);
133         }
134         /* Fall through */
135 out:
136         /* Return to the old address space.  We switched to p in the first place if
137          * it wasn't the same as the original current (old_proc). */
138         if (old_proc != p) {
139                 pcpui->cur_proc = old_proc;
140                 if (old_proc)
141                         lcr3(old_proc->env_cr3);
142                 else
143                         lcr3(boot_cr3);
144         }
145 }
146
147 /* Send an event for the kernel event ev_num.  These are the "one sided" kernel
148  * initiated events, that require a lookup of the ev_q in procdata.  This is
149  * roughly equivalent to the old "proc_notify()" */
150 void send_kernel_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid)
151 {
152         uint16_t ev_num = msg->ev_type;
153         assert(ev_num < MAX_NR_EVENT);          /* events start at 0 */
154         struct event_queue *ev_q = p->procdata->kernel_evts[ev_num];
155         if (ev_q)
156                 send_event(p, ev_q, msg, vcoreid);
157 }
158
159 /* Writes the msg to the vcpd/default mbox of the vcore.  Needs to load current,
160  * but doesn't need to care about what the process wants.  Note this isn't
161  * commonly used - just the monitor and sys_self_notify(). */
162 void post_vcore_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid)
163 {
164         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
165         struct proc *old_proc = pcpui->cur_proc;        /* uncounted ref */
166         /* Need to set p as current to post the event */
167         if (old_proc != p) {
168                 pcpui->cur_proc = p;
169                 lcr3(p->env_cr3);
170         }
171         /* *ev_mbox is the user address of the vcpd mbox */
172         post_ev_msg(get_proc_ev_mbox(vcoreid), msg, 0); /* no chance for a NOMSG */
173         /* Unload the address space, if applicable */
174         if (old_proc != p) {
175                 pcpui->cur_proc = old_proc;
176                 if (old_proc)
177                         lcr3(old_proc->env_cr3);
178                 else
179                         lcr3(boot_cr3);
180         }
181 }