14d14d88ebb7f67730f0186d52e1fd2280cb85dd
[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("[kernel] Sending event type %d to mbox %08p\n", msg->ev_type, mbox);
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 proc *old_proc;
57         struct event_mbox *ev_mbox = 0, *vcore_mbox;
58         struct event_msg local_msg = {0};
59         assert(p);
60         printd("[kernel] sending msg to proc %08p, ev_q %08p\n", p, ev_q);
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         old_proc = switch_to(p);
73         /* Get the mbox and vcoreid */
74         /* If we're going with APPRO, we use the kernel's suggested vcore's ev_mbox.
75          * vcoreid is already what the kernel suggests. */
76         if (ev_q->ev_flags & EVENT_VCORE_APPRO) {
77                 ev_mbox = get_proc_ev_mbox(vcoreid);
78         } else {        /* common case */
79                 ev_mbox = ev_q->ev_mbox;
80                 vcoreid = ev_q->ev_vcore;
81         }
82         /* Check on the style, which could affect our mbox selection.  Other styles
83          * would go here (or in similar functions we call to).  Important thing is
84          * we come out knowing which vcore to send to in the event of an IPI/INDIR,
85          * and we know what mbox to post to. */
86         if (ev_q->ev_flags & EVENT_ROUNDROBIN) {
87                 /* Pick a vcore, and if we don't have a mbox yet, pick that vcore's
88                  * default mbox.  Assuming ev_vcore was the previous one used.  Note
89                  * that round-robin overrides the passed-in vcoreid. */
90                 vcoreid = (ev_q->ev_vcore + 1) % p->procinfo->num_vcores;
91                 ev_q->ev_vcore = vcoreid;
92                 /* Note that the style of not having a specific ev_mbox may go away.  I
93                  * can't think of legitimate uses of this for now, since things that are
94                  * RR probably are non-vcore-business, and thus inappropriate for a VCPD
95                  * ev_mbox. */
96                 if (!ev_mbox)
97                         ev_mbox = get_proc_ev_mbox(vcoreid);
98         }
99         /* At this point, we ought to have the right mbox to send the msg to, and
100          * which vcore to send an IPI to (if we send one).  The mbox could be the
101          * vcore's vcpd ev_mbox.  The vcoreid only matters for IPIs and INDIRs. */
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         /* Even if we're using an mbox in procdata (VCPD), we want a user pointer */
108         if (!is_user_rwaddr(ev_mbox, sizeof(struct event_mbox))) {
109                 /* Ought to kill them, just warn for now */
110                 warn("[kernel] Illegal addr for ev_mbox");
111                 goto out;
112         }
113         /* We used to support no msgs, but quit being lazy and send a 'msg'.  If the
114          * ev_q is a NOMSG, we won't actually memcpy or anything, it'll just be a
115          * vehicle for sending the ev_type. */
116         assert(msg);
117         post_ev_msg(ev_mbox, msg, ev_q->ev_flags);
118         /* Vcore options: IPIs and INDIRs */
119         if (ev_q->ev_flags & EVENT_INDIR) {
120                 vcore_mbox = get_proc_ev_mbox(vcoreid);
121                 /* Help out userspace, since we can detect this bug:*/
122                 if (ev_mbox == vcore_mbox)
123                         printk("[kernel] EVENT_INDIR requested for a VCPD mbox!\n");
124                 /* Actually post the INDIR */
125                 local_msg.ev_type = EV_EVENT;
126                 local_msg.ev_arg3 = ev_q;
127                 post_ev_msg(vcore_mbox, &local_msg, 0);
128         }
129         if (ev_q->ev_flags & EVENT_IPI)
130                 proc_notify(p, vcoreid);
131         /* Fall through */
132 out:
133         /* Return to the old address space. */
134         switch_back(p, old_proc);
135 }
136
137 /* Send an event for the kernel event ev_num.  These are the "one sided" kernel
138  * initiated events, that require a lookup of the ev_q in procdata.  This is
139  * roughly equivalent to the old "proc_notify()" */
140 void send_kernel_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid)
141 {
142         uint16_t ev_num = msg->ev_type;
143         assert(ev_num < MAX_NR_EVENT);          /* events start at 0 */
144         struct event_queue *ev_q = p->procdata->kernel_evts[ev_num];
145         if (ev_q)
146                 send_event(p, ev_q, msg, vcoreid);
147 }
148
149 /* Writes the msg to the vcpd/default mbox of the vcore.  Needs to load current,
150  * but doesn't need to care about what the process wants.  Note this isn't
151  * commonly used - just the monitor and sys_self_notify(). */
152 void post_vcore_event(struct proc *p, struct event_msg *msg, uint32_t vcoreid)
153 {
154         /* Need to set p as current to post the event */
155         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
156         struct proc *old_proc = switch_to(p);
157         /* *ev_mbox is the user address of the vcpd mbox */
158         post_ev_msg(get_proc_ev_mbox(vcoreid), msg, 0); /* no chance for a NOMSG */
159         switch_back(p, old_proc);
160 }