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