Helper, check for the existence of local RKMS
[akaros.git] / kern / src / trap.c
1 /* Copyright (c) 2012 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Arch-independent trap handling and kernel messaging */
6
7 #include <arch/arch.h>
8 #include <smp.h>
9 #include <trap.h>
10 #include <stdio.h>
11 #include <slab.h>
12 #include <assert.h>
13 #include <kdebug.h>
14 #include <kmalloc.h>
15
16 void reflect_unhandled_trap(unsigned int trap_nr, unsigned int err,
17                             unsigned long aux)
18 {
19         uint32_t coreid = core_id();
20         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
21         struct proc *p = pcpui->cur_proc;
22         uint32_t vcoreid = pcpui->owning_vcoreid;
23         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
24         struct hw_trapframe *hw_tf = &pcpui->cur_ctx->tf.hw_tf;
25         assert(p);
26         assert(pcpui->cur_ctx && (pcpui->cur_ctx->type == ROS_HW_CTX));
27         if (!(p->procinfo->is_mcp)) {
28                 printk("Unhandled SCP trap\n");
29                 goto error_out;
30         }
31         if (vcpd->notif_disabled) {
32                 printk("Unhandled MCP trap in vcore context\n");
33                 goto error_out;
34         }
35         /* need to store trap_nr, err code, and aux into the tf so that it can get
36          * extracted on the other end, and we need to flag the TF in some way so we
37          * can tell it was reflected.  for example, on a PF, we need some number (14
38          * on x86), the prot violation (write, read, etc), and the virt addr (aux).
39          * parlib will know how to extract this info. */
40         __arch_reflect_trap_hwtf(hw_tf, trap_nr, err, aux);
41         /* the guts of a __notify */
42         vcpd->notif_disabled = TRUE;
43         vcpd->uthread_ctx = *pcpui->cur_ctx;
44         memset(pcpui->cur_ctx, 0, sizeof(struct user_context));
45         proc_init_ctx(pcpui->cur_ctx, vcoreid, p->env_entry,
46                       vcpd->transition_stack, vcpd->vcore_tls_desc);
47         return;
48 error_out:
49         print_trapframe(hw_tf);
50         enable_irq();
51         proc_destroy(p);
52 }
53
54 struct kmem_cache *kernel_msg_cache;
55
56 void kernel_msg_init(void)
57 {
58         kernel_msg_cache = kmem_cache_create("kernel_msgs",
59                            sizeof(struct kernel_message), ARCH_CL_SIZE, 0, 0, 0);
60 }
61
62 uint32_t send_kernel_message(uint32_t dst, amr_t pc, long arg0, long arg1,
63                              long arg2, int type)
64 {
65         kernel_message_t *k_msg;
66         assert(pc);
67         // note this will be freed on the destination core
68         k_msg = kmem_cache_alloc(kernel_msg_cache, 0);
69         k_msg->srcid = core_id();
70         k_msg->dstid = dst;
71         k_msg->pc = pc;
72         k_msg->arg0 = arg0;
73         k_msg->arg1 = arg1;
74         k_msg->arg2 = arg2;
75         switch (type) {
76                 case KMSG_IMMEDIATE:
77                         spin_lock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
78                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].immed_amsgs, k_msg, link);
79                         spin_unlock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
80                         break;
81                 case KMSG_ROUTINE:
82                         spin_lock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
83                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].routine_amsgs, k_msg, link);
84                         spin_unlock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
85                         break;
86                 default:
87                         panic("Unknown type of kernel message!");
88         }
89         /* since we touched memory the other core will touch (the lock), we don't
90          * need an wmb_f() */
91         /* if we're sending a routine message locally, we don't want/need an IPI */
92         if ((dst != k_msg->srcid) || (type == KMSG_IMMEDIATE))
93                 send_ipi(dst, I_KERNEL_MSG);
94         return 0;
95 }
96
97 /* Kernel message IPI/IRQ handler.
98  *
99  * This processes immediate messages, and that's it (it used to handle routines
100  * too, if it came in from userspace).  Routine messages will get processed when
101  * the kernel has a chance (right before popping to userspace or in smp_idle
102  * before halting).
103  *
104  * Note that all of this happens from interrupt context, and interrupts are
105  * disabled. */
106 void handle_kmsg_ipi(struct hw_trapframe *hw_tf, void *data)
107 {
108         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
109         struct kernel_message *kmsg_i, *temp;
110         /* Avoid locking if the list appears empty (lockless peek is okay) */
111         if (STAILQ_EMPTY(&pcpui->immed_amsgs))
112                 return;
113         /* The lock serves as a cmb to force a re-read of the head of the list */
114         spin_lock_irqsave(&pcpui->immed_amsg_lock);
115         STAILQ_FOREACH_SAFE(kmsg_i, &pcpui->immed_amsgs, link, temp) {
116                 pcpui_trace_kmsg(pcpui, (uintptr_t)kmsg_i->pc);
117                 kmsg_i->pc(kmsg_i->srcid, kmsg_i->arg0, kmsg_i->arg1, kmsg_i->arg2);
118                 STAILQ_REMOVE(&pcpui->immed_amsgs, kmsg_i, kernel_message, link);
119                 kmem_cache_free(kernel_msg_cache, (void*)kmsg_i);
120         }
121         spin_unlock_irqsave(&pcpui->immed_amsg_lock);
122 }
123
124 bool has_routine_kmsg(void)
125 {
126         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
127         /* lockless peek */
128         return !STAILQ_EMPTY(&pcpui->routine_amsgs);
129 }
130
131 /* Helper function, gets the next routine KMSG (RKM).  Returns 0 if the list was
132  * empty. */
133 static kernel_message_t *get_next_rkmsg(struct per_cpu_info *pcpui)
134 {
135         struct kernel_message *kmsg;
136         /* Avoid locking if the list appears empty (lockless peek is okay) */
137         if (STAILQ_EMPTY(&pcpui->routine_amsgs))
138                 return 0;
139         /* The lock serves as a cmb to force a re-read of the head of the list.
140          * IRQs are disabled by our caller. */
141         spin_lock(&pcpui->routine_amsg_lock);
142         kmsg = STAILQ_FIRST(&pcpui->routine_amsgs);
143         if (kmsg)
144                 STAILQ_REMOVE_HEAD(&pcpui->routine_amsgs, link);
145         spin_unlock(&pcpui->routine_amsg_lock);
146         return kmsg;
147 }
148
149 /* Runs routine kernel messages.  This might not return.  In the past, this
150  * would also run immediate messages, but this is unnecessary.  Immediates will
151  * run whenever we reenable IRQs.  We could have some sort of ordering or
152  * guarantees between KMSG classes, but that's not particularly useful at this
153  * point.
154  *
155  * Note this runs from normal context, with interruptes disabled.  However, a
156  * particular RKM could enable interrupts - for instance __launch_kthread() will
157  * restore an old kthread that may have had IRQs on. */
158 void process_routine_kmsg(void)
159 {
160         uint32_t pcoreid = core_id();
161         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
162         struct kernel_message msg_cp, *kmsg;
163
164         /* Important that callers have IRQs disabled.  When sending cross-core RKMs,
165          * the IPI is used to keep the core from going to sleep - even though RKMs
166          * aren't handled in the kmsg handler.  Check smp_idle() for more info. */
167         assert(!irq_is_enabled());
168         while ((kmsg = get_next_rkmsg(pcpui))) {
169                 /* Copy in, and then free, in case we don't return */
170                 msg_cp = *kmsg;
171                 kmem_cache_free(kernel_msg_cache, (void*)kmsg);
172                 assert(msg_cp.dstid == pcoreid);        /* caught a brutal bug with this */
173                 set_rkmsg(pcpui);                                       /* we're now in early RKM ctx */
174                 /* The kmsg could block.  If it does, we want the kthread code to know
175                  * it's not running on behalf of a process, and we're actually spawning
176                  * a kernel task.  While we do have a syscall that does work in an RKM
177                  * (change_to), it's not really the rest of the syscall context. */
178                 pcpui->cur_kthread->is_ktask = TRUE;
179                 pcpui_trace_kmsg(pcpui, (uintptr_t)msg_cp.pc);
180                 msg_cp.pc(msg_cp.srcid, msg_cp.arg0, msg_cp.arg1, msg_cp.arg2);
181                 /* And if we make it back, be sure to unset this.  If we never return,
182                  * but the kthread exits via some other way (smp_idle()), then
183                  * smp_idle() will deal with the flag.  The default state is "off".  For
184                  * an example of an RKM that does this, check out the
185                  * monitor->mon_bin_run.  Finally, if the kthread gets swapped out of
186                  * pcpui, such as in __launch_kthread(), the next time the kthread is
187                  * reused, is_ktask will be reset. */
188                 pcpui->cur_kthread->is_ktask = FALSE;
189                 /* If we aren't still in early RKM, it is because the KMSG blocked
190                  * (thus leaving early RKM, finishing in default context) and then
191                  * returned.  This is a 'detached' RKM.  Must idle in this scenario,
192                  * since we might have migrated or otherwise weren't meant to PRKM
193                  * (can't return twice).  Also note that this may involve a core
194                  * migration, so we need to reread pcpui.*/
195                 cmb();
196                 pcpui = &per_cpu_info[core_id()];
197                 if (!in_early_rkmsg_ctx(pcpui))
198                         smp_idle();
199                 clear_rkmsg(pcpui);
200                 /* Some RKMs might turn on interrupts (perhaps in the future) and then
201                  * return. */
202                 disable_irq();
203         }
204 }
205
206 /* extremely dangerous and racy: prints out the immed and routine kmsgs for a
207  * specific core (so possibly remotely) */
208 void print_kmsgs(uint32_t coreid)
209 {
210         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
211         void __print_kmsgs(struct kernel_msg_list *list, char *type)
212         {
213                 char *fn_name;
214                 struct kernel_message *kmsg_i;
215                 STAILQ_FOREACH(kmsg_i, list, link) {
216                         fn_name = get_fn_name((long)kmsg_i->pc);
217                         printk("%s KMSG on %d from %d to run %p(%s)\n", type,
218                                kmsg_i->dstid, kmsg_i->srcid, kmsg_i->pc, fn_name); 
219                         kfree(fn_name);
220                 }
221         }
222         __print_kmsgs(&pcpui->immed_amsgs, "Immedte");
223         __print_kmsgs(&pcpui->routine_amsgs, "Routine");
224 }
225
226 /* Debugging stuff */
227 void kmsg_queue_stat(void)
228 {
229         struct kernel_message *kmsg;
230         bool immed_emp, routine_emp;
231         for (int i = 0; i < num_cpus; i++) {
232                 spin_lock_irqsave(&per_cpu_info[i].immed_amsg_lock);
233                 immed_emp = STAILQ_EMPTY(&per_cpu_info[i].immed_amsgs);
234                 spin_unlock_irqsave(&per_cpu_info[i].immed_amsg_lock);
235                 spin_lock_irqsave(&per_cpu_info[i].routine_amsg_lock);
236                 routine_emp = STAILQ_EMPTY(&per_cpu_info[i].routine_amsgs);
237                 spin_unlock_irqsave(&per_cpu_info[i].routine_amsg_lock);
238                 printk("Core %d's immed_emp: %d, routine_emp %d\n", i, immed_emp,
239                routine_emp);
240                 if (!immed_emp) {
241                         kmsg = STAILQ_FIRST(&per_cpu_info[i].immed_amsgs);
242                         printk("Immed msg on core %d:\n", i);
243                         printk("\tsrc:  %d\n", kmsg->srcid);
244                         printk("\tdst:  %d\n", kmsg->dstid);
245                         printk("\tpc:   %p\n", kmsg->pc);
246                         printk("\targ0: %p\n", kmsg->arg0);
247                         printk("\targ1: %p\n", kmsg->arg1);
248                         printk("\targ2: %p\n", kmsg->arg2);
249                 }
250                 if (!routine_emp) {
251                         kmsg = STAILQ_FIRST(&per_cpu_info[i].routine_amsgs);
252                         printk("Routine msg on core %d:\n", i);
253                         printk("\tsrc:  %d\n", kmsg->srcid);
254                         printk("\tdst:  %d\n", kmsg->dstid);
255                         printk("\tpc:   %p\n", kmsg->pc);
256                         printk("\targ0: %p\n", kmsg->arg0);
257                         printk("\targ1: %p\n", kmsg->arg1);
258                         printk("\targ2: %p\n", kmsg->arg2);
259                 }
260                         
261         }
262 }
263
264 void print_kctx_depths(const char *str)
265 {
266         uint32_t coreid = core_id();
267         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
268         
269         if (!str)
270                 str = "(none)";
271         printk("%s: Core %d, irq depth %d, ktrap depth %d, irqon %d\n", str, coreid,
272                irq_depth(pcpui), ktrap_depth(pcpui), irq_is_enabled());
273 }
274
275 void print_user_ctx(struct user_context *ctx)
276 {
277         if (ctx->type == ROS_SW_CTX)
278                 print_swtrapframe(&ctx->tf.sw_tf);
279         else if (ctx->type == ROS_HW_CTX)
280                 print_trapframe(&ctx->tf.hw_tf);
281         else
282                 printk("Bad TF %p type %d!\n", ctx, ctx->type);
283 }