x86: interrupt return path checks kmsgs
[akaros.git] / kern / arch / i686 / trap.c
1 #ifdef __SHARC__
2 #pragma nosharc
3 #define SINIT(x) x
4 #endif
5
6 #include <arch/mmu.h>
7 #include <arch/x86.h>
8 #include <arch/arch.h>
9 #include <arch/console.h>
10 #include <arch/apic.h>
11 #include <ros/common.h>
12 #include <smp.h>
13 #include <assert.h>
14 #include <pmap.h>
15 #include <trap.h>
16 #include <monitor.h>
17 #include <process.h>
18 #include <mm.h>
19 #include <stdio.h>
20 #include <slab.h>
21 #include <syscall.h>
22
23 taskstate_t RO ts;
24
25 /* Interrupt descriptor table.  (Must be built at run time because
26  * shifted function addresses can't be represented in relocation records.)
27  */
28 // Aligned on an 8 byte boundary (SDM V3A 5-13)
29 gatedesc_t __attribute__ ((aligned (8))) (RO idt)[256] = { { 0 } };
30 pseudodesc_t RO idt_pd = {
31         sizeof(idt) - 1, (uint32_t) idt
32 };
33
34 /* global handler table, used by core0 (for now).  allows the registration
35  * of functions to be called when servicing an interrupt.  other cores
36  * can set up their own later.
37  */
38 #ifdef __IVY__
39 #pragma cilnoremove("iht_lock")
40 #endif
41 spinlock_t iht_lock;
42 handler_t TP(TV(t)) LCKD(&iht_lock) (RO interrupt_handlers)[NUM_INTERRUPT_HANDLERS];
43
44 static const char *NTS trapname(int trapno)
45 {
46     // zra: excnames is SREADONLY because Ivy doesn't trust const
47         static const char *NT const (RO excnames)[] = {
48                 "Divide error",
49                 "Debug",
50                 "Non-Maskable Interrupt",
51                 "Breakpoint",
52                 "Overflow",
53                 "BOUND Range Exceeded",
54                 "Invalid Opcode",
55                 "Device Not Available",
56                 "Double Fault",
57                 "Coprocessor Segment Overrun",
58                 "Invalid TSS",
59                 "Segment Not Present",
60                 "Stack Fault",
61                 "General Protection",
62                 "Page Fault",
63                 "(unknown trap)",
64                 "x87 FPU Floating-Point Error",
65                 "Alignment Check",
66                 "Machine-Check",
67                 "SIMD Floating-Point Exception"
68         };
69
70         if (trapno < sizeof(excnames)/sizeof(excnames[0]))
71                 return excnames[trapno];
72         if (trapno == T_SYSCALL)
73                 return "System call";
74         return "(unknown trap)";
75 }
76
77 /* Set stacktop for the current core to be the stack the kernel will start on
78  * when trapping/interrupting from userspace.  Don't use this til after
79  * smp_percpu_init().  We can probably get the TSS by reading the task register
80  * and then the GDT.  Still, it's a pain. */
81 void set_stack_top(uintptr_t stacktop)
82 {
83         struct per_cpu_info *pcpu = &per_cpu_info[core_id()];
84         /* No need to reload the task register, this takes effect immediately */
85         pcpu->tss->ts_esp0 = stacktop;
86         /* Also need to make sure sysenters come in correctly */
87         write_msr(MSR_IA32_SYSENTER_ESP, stacktop);
88 }
89
90 /* Note the check implies we only are on a one page stack (or the first page) */
91 uintptr_t get_stack_top(void)
92 {
93         uintptr_t stacktop = per_cpu_info[core_id()].tss->ts_esp0;
94         if (stacktop != ROUNDUP(read_esp(), PGSIZE))
95                 panic("Bad stacktop: %08p esp one is %08p\n", stacktop,
96                       ROUNDUP(read_esp(), PGSIZE));
97         return stacktop;
98 }
99
100 /* Starts running the current TF, just using ret. */
101 void pop_kernel_tf(struct trapframe *tf)
102 {
103         asm volatile ("movl %1,%%esp;           " /* move to future stack */
104                       "pushl %2;                " /* push cs */
105                       "movl %0,%%esp;           " /* move to TF */
106                       "addl $0x20,%%esp;        " /* move to tf_gs slot */
107                       "movl %1,(%%esp);         " /* write future esp */
108                       "subl $0x20,%%esp;        " /* move back to tf start */
109                       "popal;                   " /* restore regs */
110                       "popl %%esp;              " /* set stack ptr */
111                       "subl $0x4,%%esp;         " /* jump down past CS */
112                       "ret                      " /* return to the EIP */
113                       :
114                       : "g"(tf), "r"(tf->tf_esp), "r"(tf->tf_eip) : "memory");
115         panic("ret failed");                            /* mostly to placate your mom */
116 }
117
118 void idt_init(void)
119 {
120         extern segdesc_t (RO gdt)[];
121
122         // This table is made in trapentry.S by each macro in that file.
123         // It is layed out such that the ith entry is the ith's traphandler's
124         // (uint32_t) trap addr, then (uint32_t) trap number
125         struct trapinfo { uint32_t trapaddr; uint32_t trapnumber; };
126         extern struct trapinfo (BND(__this,trap_tbl_end) RO trap_tbl)[];
127         extern struct trapinfo (SNT RO trap_tbl_end)[];
128         int i, trap_tbl_size = trap_tbl_end - trap_tbl;
129         extern void ISR_default(void);
130
131         // set all to default, to catch everything
132         for(i = 0; i < 256; i++)
133                 ROSETGATE(idt[i], 0, GD_KT, &ISR_default, 0);
134
135         // set all entries that have real trap handlers
136         // we need to stop short of the last one, since the last is the default
137         // handler with a fake interrupt number (500) that is out of bounds of
138         // the idt[]
139         // if we set these to trap gates, be sure to handle the IRQs separately
140         // and we might need to break our pretty tables
141         for(i = 0; i < trap_tbl_size - 1; i++)
142                 ROSETGATE(idt[trap_tbl[i].trapnumber], 0, GD_KT, trap_tbl[i].trapaddr, 0);
143
144         // turn on syscall handling and other user-accessible ints
145         // DPL 3 means this can be triggered by the int instruction
146         // STS_TG32 sets the IDT type to a Trap Gate (interrupts enabled)
147         idt[T_SYSCALL].gd_dpl = SINIT(3);
148         idt[T_SYSCALL].gd_type = SINIT(STS_TG32);
149         idt[T_BRKPT].gd_dpl = SINIT(3);
150
151         /* Setup a TSS so that we get the right stack when we trap to the kernel.
152          * We need to use the KVA for stacktop, and not the memlayout virtual
153          * address, so we can free it later (and check for other bugs). */
154         pte_t *pte = pgdir_walk(boot_pgdir, (void*)KSTACKTOP - PGSIZE, 0);
155         uintptr_t stacktop_kva = (uintptr_t)ppn2kva(PTE2PPN(*pte)) + PGSIZE;
156         ts.ts_esp0 = stacktop_kva;
157         ts.ts_ss0 = SINIT(GD_KD);
158
159         // Initialize the TSS field of the gdt.
160         SEG16ROINIT(gdt[GD_TSS >> 3],STS_T32A, (uint32_t)(&ts),sizeof(taskstate_t),0);
161         //gdt[GD_TSS >> 3] = (segdesc_t)SEG16(STS_T32A, (uint32_t) (&ts),
162         //                                 sizeof(taskstate_t), 0);
163         gdt[GD_TSS >> 3].sd_s = SINIT(0);
164
165         // Load the TSS
166         ltr(GD_TSS);
167
168         // Load the IDT
169         asm volatile("lidt idt_pd");
170
171         // This will go away when we start using the IOAPIC properly
172         pic_remap();
173         // set LINT0 to receive ExtINTs (KVM's default).  At reset they are 0x1000.
174         write_mmreg32(LAPIC_LVT_LINT0, 0x700);
175         // mask it to shut it up for now
176         mask_lapic_lvt(LAPIC_LVT_LINT0);
177         // and turn it on
178         lapic_enable();
179         /* register the generic timer_interrupt() handler for the per-core timers */
180         register_interrupt_handler(interrupt_handlers, LAPIC_TIMER_DEFAULT_VECTOR,
181                                    timer_interrupt, NULL);
182 }
183
184 void
185 print_regs(push_regs_t *regs)
186 {
187         cprintf("  edi  0x%08x\n", regs->reg_edi);
188         cprintf("  esi  0x%08x\n", regs->reg_esi);
189         cprintf("  ebp  0x%08x\n", regs->reg_ebp);
190         cprintf("  oesp 0x%08x\n", regs->reg_oesp);
191         cprintf("  ebx  0x%08x\n", regs->reg_ebx);
192         cprintf("  edx  0x%08x\n", regs->reg_edx);
193         cprintf("  ecx  0x%08x\n", regs->reg_ecx);
194         cprintf("  eax  0x%08x\n", regs->reg_eax);
195 }
196
197 void
198 print_trapframe(trapframe_t *tf)
199 {
200         static spinlock_t ptf_lock;
201
202         spin_lock_irqsave(&ptf_lock);
203         printk("TRAP frame at %p on core %d\n", tf, core_id());
204         print_regs(&tf->tf_regs);
205         printk("  gs   0x----%04x\n", tf->tf_gs);
206         printk("  fs   0x----%04x\n", tf->tf_fs);
207         printk("  es   0x----%04x\n", tf->tf_es);
208         printk("  ds   0x----%04x\n", tf->tf_ds);
209         printk("  trap 0x%08x %s\n", tf->tf_trapno, trapname(tf->tf_trapno));
210         printk("  err  0x%08x\n", tf->tf_err);
211         printk("  eip  0x%08x\n", tf->tf_eip);
212         printk("  cs   0x----%04x\n", tf->tf_cs);
213         printk("  flag 0x%08x\n", tf->tf_eflags);
214         /* Prevents us from thinking these mean something for nested interrupts. */
215         if (tf->tf_cs != GD_KT) {
216                 printk("  esp  0x%08x\n", tf->tf_esp);
217                 printk("  ss   0x----%04x\n", tf->tf_ss);
218         }
219         spin_unlock_irqsave(&ptf_lock);
220 }
221
222 static void
223 trap_dispatch(trapframe_t *tf)
224 {
225         // Handle processor exceptions.
226         switch(tf->tf_trapno) {
227                 case T_BRKPT:
228                         monitor(tf);
229                         break;
230                 case T_PGFLT:
231                         page_fault_handler(tf);
232                         break;
233                 case T_SYSCALL:
234                         // check for userspace, for now
235                         assert(tf->tf_cs != GD_KT);
236                         struct per_cpu_info* coreinfo = &per_cpu_info[core_id()];
237                         coreinfo->cur_ret.returnloc = &(tf->tf_regs.reg_eax);
238                         coreinfo->cur_ret.errno_loc = &(tf->tf_regs.reg_esi);
239                         // syscall code wants an edible reference for current
240                         kref_get(&coreinfo->cur_proc->kref, 1);
241                         tf->tf_regs.reg_eax =
242                                 syscall(coreinfo->cur_proc, tf->tf_regs.reg_eax, tf->tf_regs.reg_edx,
243                                         tf->tf_regs.reg_ecx, tf->tf_regs.reg_ebx,
244                                         tf->tf_regs.reg_edi, tf->tf_regs.reg_esi);
245                         kref_put(&coreinfo->cur_proc->kref);
246                         break;
247                 default:
248                         // Unexpected trap: The user process or the kernel has a bug.
249                         print_trapframe(tf);
250                         if (tf->tf_cs == GD_KT)
251                                 panic("Damn Damn!  Unhandled trap in the kernel!");
252                         else {
253                                 warn("Unexpected trap from userspace");
254                                 kref_get(&current->kref, 1);
255                                 proc_destroy(current);
256                                 return;
257                         }
258         }
259         return;
260 }
261
262 void
263 env_push_ancillary_state(env_t* e)
264 {
265         // TODO: (HSS) handle silly state (don't really want this per-process)
266         // Here's where you'll save FP/MMX/XMM regs
267 }
268
269 void
270 env_pop_ancillary_state(env_t* e)
271 {
272         // Here's where you'll restore FP/MMX/XMM regs
273 }
274
275 void trap(struct trapframe *tf)
276 {
277         printd("Incoming TRAP %d on core %d, TF at %p\n", tf->tf_trapno, core_id(),
278                tf);
279         /* Note we are not preemptively saving the TF in the env_tf.  We do maintain
280          * a reference to it in current_tf (a per-cpu pointer).
281          * In general, only save the tf and any silly state once you know it
282          * is necessary (blocking).  And only save it in env_tf when you know you
283          * are single core (PROC_RUNNING_S) */
284         if (!in_kernel(tf))
285                 set_current_tf(tf);
286         if ((tf->tf_cs & ~3) != GD_UT && (tf->tf_cs & ~3) != GD_KT) {
287                 print_trapframe(tf);
288                 panic("Trapframe with invalid CS!");
289         }
290         trap_dispatch(tf);
291         /* Return to the current process, which should be runnable.  If we're the
292          * kernel, we should just return naturally.  Note that current and tf need
293          * to still be okay (might not be after blocking) */
294         if (in_kernel(tf))
295                 return;
296         proc_restartcore(current, tf);
297         assert(0);
298 }
299
300 void irq_handler(struct trapframe *tf)
301 {
302         if (!in_kernel(tf))
303                 set_current_tf(tf);
304         //if (core_id())
305                 printd("Incoming IRQ, ISR: %d on core %d\n", tf->tf_trapno, core_id());
306
307         extern handler_wrapper_t (RO handler_wrappers)[NUM_HANDLER_WRAPPERS];
308
309         // determine the interrupt handler table to use.  for now, pick the global
310         handler_t TP(TV(t)) LCKD(&iht_lock) * handler_tbl = interrupt_handlers;
311
312         if (handler_tbl[tf->tf_trapno].isr != 0)
313                 handler_tbl[tf->tf_trapno].isr(tf, handler_tbl[tf->tf_trapno].data);
314         // if we're a general purpose IPI function call, down the cpu_list
315         if ((I_SMP_CALL0 <= tf->tf_trapno) && (tf->tf_trapno <= I_SMP_CALL_LAST))
316                 down_checklist(handler_wrappers[tf->tf_trapno & 0x0f].cpu_list);
317
318         // Send EOI.  might want to do this in assembly, and possibly earlier
319         // This is set up to work with an old PIC for now
320         // Convention is that all IRQs between 32 and 47 are for the PIC.
321         // All others are LAPIC (timer, IPIs, perf, non-ExtINT LINTS, etc)
322         // For now, only 235-255 are available
323         assert(tf->tf_trapno >= 32); // slows us down, but we should never have this
324
325 #ifndef __CONFIG_DISABLE_MPTABLES__
326         lapic_send_eoi();
327 #else
328         //Old PIC relatd code. Should be gone for good, but leaving it just incase.
329         if (tf->tf_trapno < 48)
330                 pic_send_eoi(tf->tf_trapno - PIC1_OFFSET);
331         else
332                 lapic_send_eoi();
333 #endif
334         /* Return to the current process, which should be runnable.  If we're the
335          * kernel, we should just return naturally.  Note that current and tf need
336          * to still be okay (might not be after blocking) */
337         if (in_kernel(tf))
338                 return;
339         proc_restartcore(current, tf);
340         assert(0);
341 }
342
343 void
344 register_interrupt_handler(handler_t TP(TV(t)) table[],
345                            uint8_t int_num, poly_isr_t handler, TV(t) data)
346 {
347         table[int_num].isr = handler;
348         table[int_num].data = data;
349 }
350
351 void page_fault_handler(struct trapframe *tf)
352 {
353         uint32_t fault_va = rcr2();
354         int prot = tf->tf_err & PF_ERROR_WRITE ? PROT_WRITE : PROT_READ;
355         int err;
356
357         /* TODO - handle kernel page faults */
358         if ((tf->tf_cs & 3) == 0) {
359                 print_trapframe(tf);
360                 panic("Page Fault in the Kernel at 0x%08x!", fault_va);
361         }
362         if ((err = handle_page_fault(current, fault_va, prot))) {
363                 /* Destroy the faulting process */
364                 printk("[%08x] user %s fault va %08x ip %08x on core %d with err %d\n",
365                        current->pid, prot & PROT_READ ? "READ" : "WRITE", fault_va,
366                        tf->tf_eip, core_id(), err);
367                 print_trapframe(tf);
368                 kref_get(&current->kref, 1);
369                 proc_destroy(current);
370         }
371 }
372
373 void sysenter_init(void)
374 {
375         write_msr(MSR_IA32_SYSENTER_CS, GD_KT);
376         write_msr(MSR_IA32_SYSENTER_ESP, ts.ts_esp0);
377         write_msr(MSR_IA32_SYSENTER_EIP, (uint32_t) &sysenter_handler);
378 }
379
380 /* This is called from sysenter's asm, with the tf on the kernel stack. */
381 void sysenter_callwrapper(struct trapframe *tf)
382 {
383         struct per_cpu_info* coreinfo = &per_cpu_info[core_id()];
384         if (!in_kernel(tf))
385                 coreinfo->cur_tf = tf;
386         coreinfo->cur_ret.returnloc = &(tf->tf_regs.reg_eax);
387         coreinfo->cur_ret.errno_loc = &(tf->tf_regs.reg_esi);
388
389         // syscall code wants an edible reference for current
390         kref_get(&current->kref, 1);
391         tf->tf_regs.reg_eax = (intreg_t) syscall(current,
392                                                  tf->tf_regs.reg_eax,
393                                                  tf->tf_regs.reg_esi,
394                                                  tf->tf_regs.reg_ecx,
395                                                  tf->tf_regs.reg_ebx,
396                                                  tf->tf_regs.reg_edi,
397                                                  0);
398         kref_put(&current->kref);
399         /*
400          * careful here - we need to make sure that this current is the right
401          * process, which could be weird if the syscall blocked.  it would need to
402          * restore the proper value in current before returning to here.
403          * likewise, tf could be pointing to random gibberish.
404          */
405         proc_restartcore(current, tf);
406 }
407
408 struct kmem_cache *kernel_msg_cache;
409 void kernel_msg_init(void)
410 {
411         kernel_msg_cache = kmem_cache_create("kernel_msgs",
412                            sizeof(struct kernel_message), HW_CACHE_ALIGN, 0, 0, 0);
413 }
414
415 uint32_t send_kernel_message(uint32_t dst, amr_t pc, TV(a0t) arg0, TV(a1t) arg1,
416                              TV(a2t) arg2, int type)
417 {
418         kernel_message_t *k_msg;
419         assert(pc);
420         // note this will be freed on the destination core
421         k_msg = (kernel_message_t *CT(1))TC(kmem_cache_alloc(kernel_msg_cache, 0));
422         k_msg->srcid = core_id();
423         k_msg->pc = pc;
424         k_msg->arg0 = arg0;
425         k_msg->arg1 = arg1;
426         k_msg->arg2 = arg2;
427         switch (type) {
428                 case KMSG_IMMEDIATE:
429                         spin_lock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
430                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].immed_amsgs, k_msg, link);
431                         spin_unlock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
432                         break;
433                 case KMSG_ROUTINE:
434                         spin_lock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
435                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].routine_amsgs, k_msg, link);
436                         spin_unlock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
437                         break;
438                 default:
439                         panic("Unknown type of kernel message!");
440         }
441         // since we touched memory the other core will touch (the lock), we don't
442         // need an wmb_f()
443         send_ipi(get_hw_coreid(dst), I_KERNEL_MSG);
444         return 0;
445 }
446
447 /* Helper function.  Returns 0 if the list was empty. */
448 static kernel_message_t *get_next_amsg(struct kernel_msg_list *list_head,
449                                        spinlock_t *list_lock)
450 {
451         kernel_message_t *k_msg;
452         spin_lock_irqsave(list_lock);
453         k_msg = STAILQ_FIRST(list_head);
454         if (k_msg)
455                 STAILQ_REMOVE_HEAD(list_head, link);
456         spin_unlock_irqsave(list_lock);
457         return k_msg;
458 }
459
460 /* Kernel message handler.  Extensive documentation is in
461  * Documentation/kernel_messages.txt.
462  *
463  * In general: this processes immediate messages, then routine messages.
464  * Routine messages might not return (__startcore, etc), so we need to be
465  * careful about a few things.
466  *
467  * Note that all of this happens from interrupt context, and interrupts are
468  * currently disabled for this gate.  Interrupts need to be disabled so that the
469  * self-ipi doesn't preempt the execution of this kernel message. */
470 void __kernel_message(struct trapframe *tf)
471 {
472         per_cpu_info_t *myinfo = &per_cpu_info[core_id()];
473         kernel_message_t msg_cp, *k_msg;
474
475         lapic_send_eoi();
476         while (1) { // will break out when there are no more messages
477                 /* Try to get an immediate message.  Exec and free it. */
478                 k_msg = get_next_amsg(&myinfo->immed_amsgs, &myinfo->immed_amsg_lock);
479                 if (k_msg) {
480                         assert(k_msg->pc);
481                         k_msg->pc(tf, k_msg->srcid, k_msg->arg0, k_msg->arg1, k_msg->arg2);
482                         kmem_cache_free(kernel_msg_cache, (void*)k_msg);
483                 } else { // no immediate, might be a routine
484                         if (in_kernel(tf))
485                                 return; // don't execute routine msgs if we were in the kernel
486                         k_msg = get_next_amsg(&myinfo->routine_amsgs,
487                                               &myinfo->routine_amsg_lock);
488                         if (!k_msg) // no routines either
489                                 return;
490                         /* copy in, and then free, in case we don't return */
491                         msg_cp = *k_msg;
492                         kmem_cache_free(kernel_msg_cache, (void*)k_msg);
493                         /* make sure an IPI is pending if we have more work */
494                         /* techincally, we don't need to lock when checking */
495                         if (!STAILQ_EMPTY(&myinfo->routine_amsgs) &&
496                                !ipi_is_pending(I_KERNEL_MSG))
497                                 send_self_ipi(I_KERNEL_MSG);
498                         /* Execute the kernel message */
499                         assert(msg_cp.pc);
500                         msg_cp.pc(tf, msg_cp.srcid, msg_cp.arg0, msg_cp.arg1, msg_cp.arg2);
501                 }
502         }
503 }
504
505 /* Runs any outstanding routine kernel messages from within the kernel.  Will
506  * make sure immediates still run first (or when they arrive, if processing a
507  * bunch of these messages).  This will disable interrupts, and restore them to
508  * whatever state you left them. */
509 void process_routine_kmsg(struct trapframe *tf)
510 {
511         per_cpu_info_t *myinfo = &per_cpu_info[core_id()];
512         kernel_message_t msg_cp, *k_msg;
513         int8_t irq_state = 0;
514
515         disable_irqsave(&irq_state);
516         /* If we were told what our TF was, use that.  o/w, go with current_tf. */
517         tf = tf ? tf : current_tf;
518         while (1) {
519                 /* normally, we want ints disabled, so we don't have an empty self-ipi
520                  * for every routine message. (imagine a long list of routines).  But we
521                  * do want immediates to run ahead of routines.  This enabling should
522                  * work (might not in some shitty VMs).  Also note we can receive an
523                  * extra self-ipi for routine messages before we turn off irqs again.
524                  * Not a big deal, since we will process it right away. 
525                  * TODO: consider calling __kernel_message() here. */
526                 if (!STAILQ_EMPTY(&myinfo->immed_amsgs)) {
527                         enable_irq();
528                         cpu_relax();
529                         disable_irq();
530                 }
531                 k_msg = get_next_amsg(&myinfo->routine_amsgs,
532                                       &myinfo->routine_amsg_lock);
533                 if (!k_msg) {
534                         enable_irqsave(&irq_state);
535                         return;
536                 }
537                 /* copy in, and then free, in case we don't return */
538                 msg_cp = *k_msg;
539                 kmem_cache_free(kernel_msg_cache, (void*)k_msg);
540                 /* make sure an IPI is pending if we have more work */
541                 if (!STAILQ_EMPTY(&myinfo->routine_amsgs) &&
542                        !ipi_is_pending(I_KERNEL_MSG))
543                         send_self_ipi(I_KERNEL_MSG);
544                 /* Execute the kernel message */
545                 assert(msg_cp.pc);
546                 msg_cp.pc(tf, msg_cp.srcid, msg_cp.arg0, msg_cp.arg1, msg_cp.arg2);
547         }
548 }