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