Add a helper to get a context's SP
[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 static void print_unhandled_trap(struct proc *p, struct user_context *ctx,
17                                  unsigned int trap_nr, unsigned int err,
18                                  unsigned long aux)
19 {
20         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
21         uint32_t vcoreid = pcpui->owning_vcoreid;
22         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
23
24         if (!proc_is_vcctx_ready(p))
25                 printk("Unhandled user trap from early SCP\n");
26         else if (vcpd->notif_disabled)
27                 printk("Unhandled user trap in vcore context from VC %d\n", vcoreid);
28         print_user_ctx(ctx);
29         printk("err 0x%x (for PFs: User 4, Wr 2, Rd 1), aux %p\n", err, aux);
30         debug_addr_proc(p, get_user_ctx_pc(ctx));
31         print_vmrs(p);
32         backtrace_user_ctx(p, ctx);
33 }
34
35 /* Traps that are considered normal operations. */
36 static bool benign_trap(unsigned int err)
37 {
38         return err & PF_VMR_BACKED;
39 }
40
41 static void printx_unhandled_trap(struct proc *p, struct user_context *ctx,
42                                   unsigned int trap_nr, unsigned int err,
43                                   unsigned long aux)
44 {
45         if (printx_on && !benign_trap(err))
46                 print_unhandled_trap(p, ctx, trap_nr, err, aux);
47 }
48
49 /* Helper, reflects the current context back to the 2LS.  Returns 0 on success,
50  * -1 on failure. */
51 int reflect_current_context(void)
52 {
53         uint32_t coreid = core_id();
54         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
55         struct proc *p = pcpui->cur_proc;
56         uint32_t vcoreid = pcpui->owning_vcoreid;
57         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
58
59         if (!proc_is_vcctx_ready(p))
60                 return -1;
61         if (vcpd->notif_disabled)
62                 return -1;
63         /* the guts of a __notify */
64         vcpd->notif_disabled = TRUE;
65         copy_current_ctx_to(&vcpd->uthread_ctx);
66         memset(pcpui->cur_ctx, 0, sizeof(struct user_context));
67         proc_init_ctx(pcpui->cur_ctx, vcoreid, vcpd->vcore_entry,
68                       vcpd->vcore_stack, vcpd->vcore_tls_desc);
69         return 0;
70 }
71
72 void reflect_unhandled_trap(unsigned int trap_nr, unsigned int err,
73                             unsigned long aux)
74 {
75         uint32_t coreid = core_id();
76         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
77         struct proc *p = pcpui->cur_proc;
78
79         assert(p);
80         assert(pcpui->cur_ctx && (pcpui->cur_ctx->type == ROS_HW_CTX));
81         /* need to store trap_nr, err code, and aux into the tf so that it can get
82          * extracted on the other end, and we need to flag the TF in some way so we
83          * can tell it was reflected.  for example, on a PF, we need some number (14
84          * on x86), the prot violation (write, read, etc), and the virt addr (aux).
85          * parlib will know how to extract this info. */
86         __arch_reflect_trap_hwtf(&pcpui->cur_ctx->tf.hw_tf, trap_nr, err, aux);
87         printx_unhandled_trap(p, pcpui->cur_ctx, trap_nr, err, aux);
88         if (reflect_current_context()) {
89                 print_unhandled_trap(p, pcpui->cur_ctx, trap_nr, err, aux);
90                 proc_destroy(p);
91         }
92 }
93
94 uintptr_t get_user_ctx_pc(struct user_context *ctx)
95 {
96         switch (ctx->type) {
97         case ROS_HW_CTX:
98                 return get_hwtf_pc(&ctx->tf.hw_tf);
99         case ROS_SW_CTX:
100                 return get_swtf_pc(&ctx->tf.sw_tf);
101         case ROS_VM_CTX:
102                 return get_vmtf_pc(&ctx->tf.vm_tf);
103         default:
104                 panic("Bad context type %d for ctx %p\n", ctx->type, ctx);
105         }
106 }
107
108 uintptr_t get_user_ctx_fp(struct user_context *ctx)
109 {
110         switch (ctx->type) {
111         case ROS_HW_CTX:
112                 return get_hwtf_fp(&ctx->tf.hw_tf);
113         case ROS_SW_CTX:
114                 return get_swtf_fp(&ctx->tf.sw_tf);
115         case ROS_VM_CTX:
116                 return get_vmtf_fp(&ctx->tf.vm_tf);
117         default:
118                 panic("Bad context type %d for ctx %p\n", ctx->type, ctx);
119         }
120 }
121
122 uintptr_t get_user_ctx_sp(struct user_context *ctx)
123 {
124         switch (ctx->type) {
125         case ROS_HW_CTX:
126                 return get_hwtf_sp(&ctx->tf.hw_tf);
127         case ROS_SW_CTX:
128                 return get_swtf_sp(&ctx->tf.sw_tf);
129         case ROS_VM_CTX:
130                 return get_vmtf_sp(&ctx->tf.vm_tf);
131         default:
132                 panic("Bad context type %d for ctx %p\n", ctx->type, ctx);
133         }
134 }
135
136 /* Helper, copies the current context to to_ctx. */
137 void copy_current_ctx_to(struct user_context *to_ctx)
138 {
139         struct user_context *cur_ctx = current_ctx;
140
141         /* Be sure to finalize into cur_ctx, not the to_ctx.  o/w the arch could get
142          * confused by other calls to finalize. */
143         arch_finalize_ctx(cur_ctx);
144         *to_ctx = *cur_ctx;
145 }
146
147 struct kmem_cache *kernel_msg_cache;
148
149 void kernel_msg_init(void)
150 {
151         kernel_msg_cache = kmem_cache_create("kernel_msgs",
152                            sizeof(struct kernel_message), ARCH_CL_SIZE, 0, 0, 0);
153 }
154
155 uint32_t send_kernel_message(uint32_t dst, amr_t pc, long arg0, long arg1,
156                              long arg2, int type)
157 {
158         kernel_message_t *k_msg;
159         assert(pc);
160         // note this will be freed on the destination core
161         k_msg = kmem_cache_alloc(kernel_msg_cache, 0);
162         k_msg->srcid = core_id();
163         k_msg->dstid = dst;
164         k_msg->pc = pc;
165         k_msg->arg0 = arg0;
166         k_msg->arg1 = arg1;
167         k_msg->arg2 = arg2;
168         switch (type) {
169                 case KMSG_IMMEDIATE:
170                         spin_lock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
171                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].immed_amsgs, k_msg, link);
172                         spin_unlock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
173                         break;
174                 case KMSG_ROUTINE:
175                         spin_lock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
176                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].routine_amsgs, k_msg, link);
177                         spin_unlock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
178                         break;
179                 default:
180                         panic("Unknown type of kernel message!");
181         }
182         /* since we touched memory the other core will touch (the lock), we don't
183          * need an wmb_f() */
184         /* if we're sending a routine message locally, we don't want/need an IPI */
185         if ((dst != k_msg->srcid) || (type == KMSG_IMMEDIATE))
186                 send_ipi(dst, I_KERNEL_MSG);
187         return 0;
188 }
189
190 /* Kernel message IPI/IRQ handler.
191  *
192  * This processes immediate messages, and that's it (it used to handle routines
193  * too, if it came in from userspace).  Routine messages will get processed when
194  * the kernel has a chance (right before popping to userspace or in smp_idle
195  * before halting).
196  *
197  * Note that all of this happens from interrupt context, and interrupts are
198  * disabled. */
199 void handle_kmsg_ipi(struct hw_trapframe *hw_tf, void *data)
200 {
201         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
202         struct kernel_message *kmsg_i, *temp;
203         /* Avoid locking if the list appears empty (lockless peek is okay) */
204         if (STAILQ_EMPTY(&pcpui->immed_amsgs))
205                 return;
206         /* The lock serves as a cmb to force a re-read of the head of the list */
207         spin_lock_irqsave(&pcpui->immed_amsg_lock);
208         STAILQ_FOREACH_SAFE(kmsg_i, &pcpui->immed_amsgs, link, temp) {
209                 pcpui_trace_kmsg(pcpui, (uintptr_t)kmsg_i->pc);
210                 kmsg_i->pc(kmsg_i->srcid, kmsg_i->arg0, kmsg_i->arg1, kmsg_i->arg2);
211                 STAILQ_REMOVE(&pcpui->immed_amsgs, kmsg_i, kernel_message, link);
212                 kmem_cache_free(kernel_msg_cache, (void*)kmsg_i);
213         }
214         spin_unlock_irqsave(&pcpui->immed_amsg_lock);
215 }
216
217 bool has_routine_kmsg(void)
218 {
219         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
220         /* lockless peek */
221         return !STAILQ_EMPTY(&pcpui->routine_amsgs);
222 }
223
224 /* Helper function, gets the next routine KMSG (RKM).  Returns 0 if the list was
225  * empty. */
226 static kernel_message_t *get_next_rkmsg(struct per_cpu_info *pcpui)
227 {
228         struct kernel_message *kmsg;
229         /* Avoid locking if the list appears empty (lockless peek is okay) */
230         if (STAILQ_EMPTY(&pcpui->routine_amsgs))
231                 return 0;
232         /* The lock serves as a cmb to force a re-read of the head of the list.
233          * IRQs are disabled by our caller. */
234         spin_lock(&pcpui->routine_amsg_lock);
235         kmsg = STAILQ_FIRST(&pcpui->routine_amsgs);
236         if (kmsg)
237                 STAILQ_REMOVE_HEAD(&pcpui->routine_amsgs, link);
238         spin_unlock(&pcpui->routine_amsg_lock);
239         return kmsg;
240 }
241
242 /* Runs routine kernel messages.  This might not return.  In the past, this
243  * would also run immediate messages, but this is unnecessary.  Immediates will
244  * run whenever we reenable IRQs.  We could have some sort of ordering or
245  * guarantees between KMSG classes, but that's not particularly useful at this
246  * point.
247  *
248  * Note this runs from normal context, with interruptes disabled.  However, a
249  * particular RKM could enable interrupts - for instance __launch_kthread() will
250  * restore an old kthread that may have had IRQs on. */
251 void process_routine_kmsg(void)
252 {
253         uint32_t pcoreid = core_id();
254         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
255         struct kernel_message msg_cp, *kmsg;
256
257         /* Important that callers have IRQs disabled.  When sending cross-core RKMs,
258          * the IPI is used to keep the core from going to sleep - even though RKMs
259          * aren't handled in the kmsg handler.  Check smp_idle() for more info. */
260         assert(!irq_is_enabled());
261         while ((kmsg = get_next_rkmsg(pcpui))) {
262                 /* Copy in, and then free, in case we don't return */
263                 msg_cp = *kmsg;
264                 kmem_cache_free(kernel_msg_cache, (void*)kmsg);
265                 assert(msg_cp.dstid == pcoreid);        /* caught a brutal bug with this */
266                 set_rkmsg(pcpui);                                       /* we're now in early RKM ctx */
267                 /* The kmsg could block.  If it does, we want the kthread code to know
268                  * it's not running on behalf of a process, and we're actually spawning
269                  * a kernel task.  While we do have a syscall that does work in an RKM
270                  * (change_to), it's not really the rest of the syscall context. */
271                 pcpui->cur_kthread->flags = KTH_KTASK_FLAGS;
272                 pcpui_trace_kmsg(pcpui, (uintptr_t)msg_cp.pc);
273                 msg_cp.pc(msg_cp.srcid, msg_cp.arg0, msg_cp.arg1, msg_cp.arg2);
274                 /* And if we make it back, be sure to restore the default flags.  If we
275                  * never return, but the kthread exits via some other way (smp_idle()),
276                  * then smp_idle() will deal with the flags.  The default state includes
277                  * 'not a ktask'. */
278                 pcpui->cur_kthread->flags = KTH_DEFAULT_FLAGS;
279                 /* If we aren't still in early RKM, it is because the KMSG blocked
280                  * (thus leaving early RKM, finishing in default context) and then
281                  * returned.  This is a 'detached' RKM.  Must idle in this scenario,
282                  * since we might have migrated or otherwise weren't meant to PRKM
283                  * (can't return twice).  Also note that this may involve a core
284                  * migration, so we need to reread pcpui.*/
285                 cmb();
286                 pcpui = &per_cpu_info[core_id()];
287                 if (!in_early_rkmsg_ctx(pcpui))
288                         smp_idle();
289                 clear_rkmsg(pcpui);
290                 /* Some RKMs might turn on interrupts (perhaps in the future) and then
291                  * return. */
292                 disable_irq();
293         }
294 }
295
296 /* extremely dangerous and racy: prints out the immed and routine kmsgs for a
297  * specific core (so possibly remotely) */
298 void print_kmsgs(uint32_t coreid)
299 {
300         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
301         void __print_kmsgs(struct kernel_msg_list *list, char *type)
302         {
303                 char *fn_name;
304                 struct kernel_message *kmsg_i;
305                 STAILQ_FOREACH(kmsg_i, list, link) {
306                         fn_name = get_fn_name((long)kmsg_i->pc);
307                         printk("%s KMSG on %d from %d to run %p(%s)\n", type,
308                                kmsg_i->dstid, kmsg_i->srcid, kmsg_i->pc, fn_name);
309                         kfree(fn_name);
310                 }
311         }
312         __print_kmsgs(&pcpui->immed_amsgs, "Immedte");
313         __print_kmsgs(&pcpui->routine_amsgs, "Routine");
314 }
315
316 /* Debugging stuff */
317 void kmsg_queue_stat(void)
318 {
319         struct kernel_message *kmsg;
320         bool immed_emp, routine_emp;
321         for (int i = 0; i < num_cores; i++) {
322                 spin_lock_irqsave(&per_cpu_info[i].immed_amsg_lock);
323                 immed_emp = STAILQ_EMPTY(&per_cpu_info[i].immed_amsgs);
324                 spin_unlock_irqsave(&per_cpu_info[i].immed_amsg_lock);
325                 spin_lock_irqsave(&per_cpu_info[i].routine_amsg_lock);
326                 routine_emp = STAILQ_EMPTY(&per_cpu_info[i].routine_amsgs);
327                 spin_unlock_irqsave(&per_cpu_info[i].routine_amsg_lock);
328                 printk("Core %d's immed_emp: %d, routine_emp %d\n", i, immed_emp,
329                routine_emp);
330                 if (!immed_emp) {
331                         kmsg = STAILQ_FIRST(&per_cpu_info[i].immed_amsgs);
332                         printk("Immed msg on core %d:\n", i);
333                         printk("\tsrc:  %d\n", kmsg->srcid);
334                         printk("\tdst:  %d\n", kmsg->dstid);
335                         printk("\tpc:   %p\n", kmsg->pc);
336                         printk("\targ0: %p\n", kmsg->arg0);
337                         printk("\targ1: %p\n", kmsg->arg1);
338                         printk("\targ2: %p\n", kmsg->arg2);
339                 }
340                 if (!routine_emp) {
341                         kmsg = STAILQ_FIRST(&per_cpu_info[i].routine_amsgs);
342                         printk("Routine msg on core %d:\n", i);
343                         printk("\tsrc:  %d\n", kmsg->srcid);
344                         printk("\tdst:  %d\n", kmsg->dstid);
345                         printk("\tpc:   %p\n", kmsg->pc);
346                         printk("\targ0: %p\n", kmsg->arg0);
347                         printk("\targ1: %p\n", kmsg->arg1);
348                         printk("\targ2: %p\n", kmsg->arg2);
349                 }
350
351         }
352 }
353
354 void print_kctx_depths(const char *str)
355 {
356         uint32_t coreid = core_id();
357         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
358
359         if (!str)
360                 str = "(none)";
361         printk("%s: Core %d, irq depth %d, ktrap depth %d, irqon %d\n", str, coreid,
362                irq_depth(pcpui), ktrap_depth(pcpui), irq_is_enabled());
363 }
364
365 void print_user_ctx(struct user_context *ctx)
366 {
367         switch (ctx->type) {
368         case ROS_HW_CTX:
369                 print_trapframe(&ctx->tf.hw_tf);
370                 break;
371         case ROS_SW_CTX:
372                 print_swtrapframe(&ctx->tf.sw_tf);
373                 break;
374         case ROS_VM_CTX:
375                 print_vmtrapframe(&ctx->tf.vm_tf);
376                 break;
377         default:
378                 printk("Bad TF %p type %d!\n", ctx, ctx->type);
379         }
380 }