Adds a KMSG tracer
[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 struct kmem_cache *kernel_msg_cache;
17
18 void kernel_msg_init(void)
19 {
20         kernel_msg_cache = kmem_cache_create("kernel_msgs",
21                            sizeof(struct kernel_message), ARCH_CL_SIZE, 0, 0, 0);
22 }
23
24 uint32_t send_kernel_message(uint32_t dst, amr_t pc, long arg0, long arg1,
25                              long arg2, int type)
26 {
27         kernel_message_t *k_msg;
28         assert(pc);
29         // note this will be freed on the destination core
30         k_msg = kmem_cache_alloc(kernel_msg_cache, 0);
31         k_msg->srcid = core_id();
32         k_msg->dstid = dst;
33         k_msg->pc = pc;
34         k_msg->arg0 = arg0;
35         k_msg->arg1 = arg1;
36         k_msg->arg2 = arg2;
37         switch (type) {
38                 case KMSG_IMMEDIATE:
39                         spin_lock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
40                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].immed_amsgs, k_msg, link);
41                         spin_unlock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
42                         break;
43                 case KMSG_ROUTINE:
44                         spin_lock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
45                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].routine_amsgs, k_msg, link);
46                         spin_unlock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
47                         break;
48                 default:
49                         panic("Unknown type of kernel message!");
50         }
51         /* since we touched memory the other core will touch (the lock), we don't
52          * need an wmb_f() */
53         /* if we're sending a routine message locally, we don't want/need an IPI */
54         if ((dst != k_msg->srcid) || (type == KMSG_IMMEDIATE))
55                 send_ipi(dst, I_KERNEL_MSG);
56         return 0;
57 }
58
59 /* Kernel message IPI/IRQ handler.
60  *
61  * This processes immediate messages, and that's it (it used to handle routines
62  * too, if it came in from userspace).  Routine messages will get processed when
63  * the kernel has a chance (right before popping to userspace or in smp_idle
64  * before halting).
65  *
66  * Note that all of this happens from interrupt context, and interrupts are
67  * disabled. */
68 void handle_kmsg_ipi(struct hw_trapframe *hw_tf, void *data)
69 {
70         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
71         struct kernel_message *kmsg_i, *temp;
72         assert(!irq_is_enabled());
73         /* Avoid locking if the list appears empty (lockless peak is okay) */
74         if (STAILQ_EMPTY(&pcpui->immed_amsgs))
75                 return;
76         /* The lock serves as a cmb to force a re-read of the head of the list */
77         spin_lock(&pcpui->immed_amsg_lock);
78         STAILQ_FOREACH_SAFE(kmsg_i, &pcpui->immed_amsgs, link, temp) {
79                 pcpui_trace_kmsg(pcpui, (uintptr_t)kmsg_i->pc);
80                 kmsg_i->pc(kmsg_i->srcid, kmsg_i->arg0, kmsg_i->arg1, kmsg_i->arg2);
81                 STAILQ_REMOVE(&pcpui->immed_amsgs, kmsg_i, kernel_message, link);
82                 kmem_cache_free(kernel_msg_cache, (void*)kmsg_i);
83         }
84         spin_unlock(&pcpui->immed_amsg_lock);
85 }
86
87 /* Helper function, gets the next routine KMSG (RKM).  Returns 0 if the list was
88  * empty. */
89 static kernel_message_t *get_next_rkmsg(struct per_cpu_info *pcpui)
90 {
91         struct kernel_message *kmsg;
92         /* Avoid locking if the list appears empty (lockless peak is okay) */
93         if (STAILQ_EMPTY(&pcpui->routine_amsgs))
94                 return 0;
95         /* The lock serves as a cmb to force a re-read of the head of the list */
96         spin_lock(&pcpui->routine_amsg_lock);
97         kmsg = STAILQ_FIRST(&pcpui->routine_amsgs);
98         if (kmsg)
99                 STAILQ_REMOVE_HEAD(&pcpui->routine_amsgs, link);
100         spin_unlock(&pcpui->routine_amsg_lock);
101         return kmsg;
102 }
103
104 /* Runs routine kernel messages.  This might not return.  In the past, this
105  * would also run immediate messages, but this is unnecessary.  Immediates will
106  * run whenever we reenable IRQs.  We could have some sort of ordering or
107  * guarantees between KMSG classes, but that's not particularly useful at this
108  * point.
109  *
110  * Note this runs from normal context, with interruptes disabled.  However, a
111  * particular RKM could enable interrupts - for instance __launch_kthread() will
112  * restore an old kthread that may have had IRQs on. */
113 void process_routine_kmsg(void)
114 {
115         uint32_t pcoreid = core_id();
116         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
117         struct kernel_message msg_cp, *kmsg;
118
119         /* Important that callers have IRQs disabled.  When sending cross-core RKMs,
120          * the IPI is used to keep the core from going to sleep - even though RKMs
121          * aren't handled in the kmsg handler.  Check smp_idle() for more info. */
122         assert(!irq_is_enabled());
123         while ((kmsg = get_next_rkmsg(pcpui))) {
124                 /* Copy in, and then free, in case we don't return */
125                 msg_cp = *kmsg;
126                 kmem_cache_free(kernel_msg_cache, (void*)kmsg);
127                 assert(msg_cp.dstid == pcoreid);        /* caught a brutal bug with this */
128                 set_rkmsg(pcpui);                                       /* we're now in early RKM ctx */
129                 pcpui_trace_kmsg(pcpui, (uintptr_t)msg_cp.pc);
130                 msg_cp.pc(msg_cp.srcid, msg_cp.arg0, msg_cp.arg1, msg_cp.arg2);
131                 /* If we aren't still in early RKM, it is because the KMSG blocked
132                  * (thus leaving early RKM, finishing in default context) and then
133                  * returned.  This is a 'detached' RKM.  Must idle in this scenario,
134                  * since we might have migrated or otherwise weren't meant to PRKM
135                  * (can't return twice).  Also note that this may involve a core
136                  * migration, so we need to reread pcpui.*/
137                 cmb();
138                 pcpui = &per_cpu_info[core_id()];
139                 if (!in_early_rkmsg_ctx(pcpui))
140                         smp_idle();
141                 clear_rkmsg(pcpui);
142                 /* Some RKMs might turn on interrupts (perhaps in the future) and then
143                  * return. */
144                 disable_irq();
145         }
146 }
147
148 /* extremely dangerous and racy: prints out the immed and routine kmsgs for a
149  * specific core (so possibly remotely) */
150 void print_kmsgs(uint32_t coreid)
151 {
152         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
153         void __print_kmsgs(struct kernel_msg_list *list, char *type)
154         {
155                 char *fn_name;
156                 struct kernel_message *kmsg_i;
157                 STAILQ_FOREACH(kmsg_i, list, link) {
158                         fn_name = get_fn_name((long)kmsg_i->pc);
159                         printk("%s KMSG on %d from %d to run %p(%s)\n", type,
160                                kmsg_i->dstid, kmsg_i->srcid, kmsg_i->pc, fn_name); 
161                         kfree(fn_name);
162                 }
163         }
164         __print_kmsgs(&pcpui->immed_amsgs, "Immedte");
165         __print_kmsgs(&pcpui->routine_amsgs, "Routine");
166 }
167
168 /* Debugging stuff */
169 void kmsg_queue_stat(void)
170 {
171         struct kernel_message *kmsg;
172         bool immed_emp, routine_emp;
173         for (int i = 0; i < num_cpus; i++) {
174                 spin_lock_irqsave(&per_cpu_info[i].immed_amsg_lock);
175                 immed_emp = STAILQ_EMPTY(&per_cpu_info[i].immed_amsgs);
176                 spin_unlock_irqsave(&per_cpu_info[i].immed_amsg_lock);
177                 spin_lock_irqsave(&per_cpu_info[i].routine_amsg_lock);
178                 routine_emp = STAILQ_EMPTY(&per_cpu_info[i].routine_amsgs);
179                 spin_unlock_irqsave(&per_cpu_info[i].routine_amsg_lock);
180                 printk("Core %d's immed_emp: %d, routine_emp %d\n", i, immed_emp,
181                routine_emp);
182                 if (!immed_emp) {
183                         kmsg = STAILQ_FIRST(&per_cpu_info[i].immed_amsgs);
184                         printk("Immed msg on core %d:\n", i);
185                         printk("\tsrc:  %d\n", kmsg->srcid);
186                         printk("\tdst:  %d\n", kmsg->dstid);
187                         printk("\tpc:   %p\n", kmsg->pc);
188                         printk("\targ0: %p\n", kmsg->arg0);
189                         printk("\targ1: %p\n", kmsg->arg1);
190                         printk("\targ2: %p\n", kmsg->arg2);
191                 }
192                 if (!routine_emp) {
193                         kmsg = STAILQ_FIRST(&per_cpu_info[i].routine_amsgs);
194                         printk("Routine msg on core %d:\n", i);
195                         printk("\tsrc:  %d\n", kmsg->srcid);
196                         printk("\tdst:  %d\n", kmsg->dstid);
197                         printk("\tpc:   %p\n", kmsg->pc);
198                         printk("\targ0: %p\n", kmsg->arg0);
199                         printk("\targ1: %p\n", kmsg->arg1);
200                         printk("\targ2: %p\n", kmsg->arg2);
201                 }
202                         
203         }
204 }
205
206 void print_kctx_depths(const char *str)
207 {
208         uint32_t coreid = core_id();
209         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
210         
211         if (!str)
212                 str = "(none)";
213         printk("%s: Core %d, irq depth %d, ktrap depth %d\n", str, coreid,
214                irq_depth(pcpui), ktrap_depth(pcpui));
215 }