Added more SharC annotations
[akaros.git] / kern / arch / i386 / trap.c
1 #ifdef __SHARC__
2 //#pragma nosharc
3 #endif
4
5 #include <arch/mmu.h>
6 #include <arch/x86.h>
7 #include <arch/arch.h>
8 #include <arch/console.h>
9 #include <arch/apic.h>
10 #include <ros/common.h>
11 #include <smp.h>
12 #include <assert.h>
13 #include <pmap.h>
14 #include <trap.h>
15 #include <monitor.h>
16 #include <process.h>
17 #include <stdio.h>
18
19 #include <syscall.h>
20
21 taskstate_t RO ts;
22
23 /* Interrupt descriptor table.  (Must be built at run time because
24  * shifted function addresses can't be represented in relocation records.)
25  */
26 // Aligned on an 8 byte boundary (SDM V3A 5-13)
27 gatedesc_t __attribute__ ((aligned (8))) (RO idt)[256] = { { 0 } };
28 pseudodesc_t RO idt_pd = {
29         sizeof(idt) - 1, (uint32_t) idt
30 };
31
32 /* global handler table, used by core0 (for now).  allows the registration
33  * of functions to be called when servicing an interrupt.  other cores
34  * can set up their own later.
35  */
36 #ifdef __IVY__
37 #pragma cilnoremove("iht_lock")
38 #endif
39 spinlock_t iht_lock;
40 handler_t TP(TV(t)) LCKD(&iht_lock) (RO interrupt_handlers)[NUM_INTERRUPT_HANDLERS];
41
42 static const char *NTS trapname(int trapno)
43 {
44     // zra: excnames is SREADONLY because Ivy doesn't trust const
45         static const char *NT const (RO excnames)[] = {
46                 "Divide error",
47                 "Debug",
48                 "Non-Maskable Interrupt",
49                 "Breakpoint",
50                 "Overflow",
51                 "BOUND Range Exceeded",
52                 "Invalid Opcode",
53                 "Device Not Available",
54                 "Double Fault",
55                 "Coprocessor Segment Overrun",
56                 "Invalid TSS",
57                 "Segment Not Present",
58                 "Stack Fault",
59                 "General Protection",
60                 "Page Fault",
61                 "(unknown trap)",
62                 "x87 FPU Floating-Point Error",
63                 "Alignment Check",
64                 "Machine-Check",
65                 "SIMD Floating-Point Exception"
66         };
67
68         if (trapno < sizeof(excnames)/sizeof(excnames[0]))
69                 return excnames[trapno];
70         if (trapno == T_SYSCALL)
71                 return "System call";
72         return "(unknown trap)";
73 }
74
75
76 void
77 idt_init(void)
78 {
79         extern segdesc_t (RO gdt)[];
80
81         // This table is made in trapentry.S by each macro in that file.
82         // It is layed out such that the ith entry is the ith's traphandler's
83         // (uint32_t) trap addr, then (uint32_t) trap number
84         struct trapinfo { uint32_t trapaddr; uint32_t trapnumber; };
85         extern struct trapinfo (BND(__this,trap_tbl_end) RO trap_tbl)[];
86         extern struct trapinfo (SNT RO trap_tbl_end)[];
87         int i, trap_tbl_size = trap_tbl_end - trap_tbl;
88         extern void ISR_default(void);
89
90         // set all to default, to catch everything
91         for(i = 0; i < 256; i++)
92                 ROSETGATE(idt[i], 0, GD_KT, &ISR_default, 0);
93
94         // set all entries that have real trap handlers
95         // we need to stop short of the last one, since the last is the default
96         // handler with a fake interrupt number (500) that is out of bounds of
97         // the idt[]
98         // if we set these to trap gates, be sure to handle the IRQs separately
99         // and we might need to break our pretty tables
100         for(i = 0; i < trap_tbl_size - 1; i++)
101                 ROSETGATE(idt[trap_tbl[i].trapnumber], 0, GD_KT, trap_tbl[i].trapaddr, 0);
102
103         // turn on syscall handling and other user-accessible ints
104         // DPL 3 means this can be triggered by the int instruction
105         // STS_TG32 sets the IDT type to a Trap Gate (interrupts enabled)
106         idt[T_SYSCALL].gd_dpl = SINIT(3);
107         idt[T_SYSCALL].gd_type = SINIT(STS_TG32);
108         idt[T_BRKPT].gd_dpl = SINIT(3);
109
110         // Setup a TSS so that we get the right stack
111         // when we trap to the kernel.
112         ts.ts_esp0 = SINIT(KSTACKTOP);
113         ts.ts_ss0 = SINIT(GD_KD);
114
115         // Initialize the TSS field of the gdt.
116         SEG16ROINIT(gdt[GD_TSS >> 3],STS_T32A, (uint32_t)(&ts),sizeof(taskstate_t),0);
117         //gdt[GD_TSS >> 3] = (segdesc_t)SEG16(STS_T32A, (uint32_t) (&ts),
118         //                                 sizeof(taskstate_t), 0);
119         gdt[GD_TSS >> 3].sd_s = SINIT(0);
120
121         // Load the TSS
122         ltr(GD_TSS);
123
124         // Load the IDT
125         asm volatile("lidt idt_pd");
126
127         // This will go away when we start using the IOAPIC properly
128         pic_remap();
129         // set LINT0 to receive ExtINTs (KVM's default).  At reset they are 0x1000.
130         write_mmreg32(LAPIC_LVT_LINT0, 0x700);
131         // mask it to shut it up for now
132         mask_lapic_lvt(LAPIC_LVT_LINT0);
133         // and turn it on
134         lapic_enable();
135 }
136
137 void
138 print_regs(push_regs_t *regs)
139 {
140         cprintf("  edi  0x%08x\n", regs->reg_edi);
141         cprintf("  esi  0x%08x\n", regs->reg_esi);
142         cprintf("  ebp  0x%08x\n", regs->reg_ebp);
143         cprintf("  oesp 0x%08x\n", regs->reg_oesp);
144         cprintf("  ebx  0x%08x\n", regs->reg_ebx);
145         cprintf("  edx  0x%08x\n", regs->reg_edx);
146         cprintf("  ecx  0x%08x\n", regs->reg_ecx);
147         cprintf("  eax  0x%08x\n", regs->reg_eax);
148 }
149
150 void
151 print_trapframe(trapframe_t *tf)
152 {
153         cprintf("TRAP frame at %p on core %d\n", tf, core_id());
154         print_regs(&tf->tf_regs);
155         cprintf("  es   0x----%04x\n", tf->tf_es);
156         cprintf("  ds   0x----%04x\n", tf->tf_ds);
157         cprintf("  trap 0x%08x %s\n", tf->tf_trapno, trapname(tf->tf_trapno));
158         cprintf("  err  0x%08x\n", tf->tf_err);
159         cprintf("  eip  0x%08x\n", tf->tf_eip);
160         cprintf("  cs   0x----%04x\n", tf->tf_cs);
161         cprintf("  flag 0x%08x\n", tf->tf_eflags);
162         cprintf("  esp  0x%08x\n", tf->tf_esp);
163         cprintf("  ss   0x----%04x\n", tf->tf_ss);
164 }
165
166 static void
167 trap_dispatch(trapframe_t *tf)
168 {
169         // Handle processor exceptions.
170         switch(tf->tf_trapno) {
171                 case T_BRKPT:
172                         while (1)
173                                 monitor(tf);
174                         // never get to this
175                         assert(0);
176                 case T_PGFLT:
177                         page_fault_handler(tf);
178                         break;
179                 case T_SYSCALL:
180                         // check for userspace, for now
181                         assert(tf->tf_cs != GD_KT);
182                         tf->tf_regs.reg_eax =
183                                 syscall(current, tf->tf_regs.reg_eax, tf->tf_regs.reg_edx,
184                                         tf->tf_regs.reg_ecx, tf->tf_regs.reg_ebx,
185                                         tf->tf_regs.reg_edi, tf->tf_regs.reg_esi);
186                         proc_startcore(current, tf); // Note the comment in syscall.c
187                         break;
188                 default:
189                         // Unexpected trap: The user process or the kernel has a bug.
190                         print_trapframe(tf);
191                         if (tf->tf_cs == GD_KT)
192                                 panic("Damn Damn!  Unhandled trap in the kernel!");
193                         else {
194                                 warn("Unexpected trap from userspace");
195                                 proc_destroy(current);
196                                 return;
197                         }
198         }
199         return;
200 }
201
202 void
203 env_push_ancillary_state(env_t* e)
204 {
205         // Here's where you'll save FP/MMX/XMM regs
206 }
207
208 void
209 env_pop_ancillary_state(env_t* e)
210 {
211         // Here's where you'll restore FP/MMX/XMM regs
212 }
213
214 void
215 trap(trapframe_t *tf)
216 {
217         //cprintf("Incoming TRAP frame at %p\n", tf);
218
219         // TODO: do this once we know we are are not returning to the current
220         // context.  doing it now is safe. (HSS)
221         env_push_ancillary_state(current);
222
223         if ((tf->tf_cs & ~3) != GD_UT && (tf->tf_cs & ~3) != GD_KT) {
224                 print_trapframe(tf);
225                 panic("Trapframe with invalid CS!");
226         }
227
228         if ((tf->tf_cs & 3) == 3) {
229                 // Trapped from user mode.
230                 // TODO: this will change when an env has more than one context
231                 // Copy trap frame (which is currently on the stack)
232                 // into 'current->env_tf', so that running the environment
233                 // will restart at the trap point.
234                 assert(current);
235                 current->env_tf = *tf;
236                 // The trapframe on the stack should be ignored from here on.
237                 tf = &current->env_tf;
238         }
239
240         // Dispatch based on what type of trap occurred
241         trap_dispatch(tf);
242
243         // should this be if == 3?  Sort out later when we handle traps.
244         // so far we never get here
245         assert(0);
246         // Return to the current environment, which should be runnable.
247         proc_startcore(current, tf); // Note the comment in syscall.c
248 }
249
250 void
251 irq_handler(trapframe_t *tf)
252 {
253         //if (core_id())
254         //      cprintf("Incoming IRQ, ISR: %d on core %d\n", tf->tf_trapno, core_id());
255         // merge this with alltraps?  other than the EOI... or do the same in all traps
256
257         // TODO: do this once we know we are are not returning to the current
258         // context.  doing it now is safe. (HSS)
259         env_push_ancillary_state(current);
260
261         extern handler_wrapper_t (RO handler_wrappers)[NUM_HANDLER_WRAPPERS];
262
263         // determine the interrupt handler table to use.  for now, pick the global
264         handler_t TP(TV(t)) LCKD(&iht_lock) * handler_tbl = interrupt_handlers;
265
266         if (handler_tbl[tf->tf_trapno].isr != 0)
267                 handler_tbl[tf->tf_trapno].isr(tf, handler_tbl[tf->tf_trapno].data);
268         // if we're a general purpose IPI function call, down the cpu_list
269         if ((I_SMP_CALL0 <= tf->tf_trapno) && (tf->tf_trapno <= I_SMP_CALL_LAST))
270                 down_checklist(handler_wrappers[tf->tf_trapno & 0x0f].cpu_list);
271
272         // Send EOI.  might want to do this in assembly, and possibly earlier
273         // This is set up to work with an old PIC for now
274         // Convention is that all IRQs between 32 and 47 are for the PIC.
275         // All others are LAPIC (timer, IPIs, perf, non-ExtINT LINTS, etc)
276         // For now, only 235-255 are available
277         assert(tf->tf_trapno >= 32); // slows us down, but we should never have this
278         if (tf->tf_trapno < 48)
279                 pic_send_eoi(tf->tf_trapno - PIC1_OFFSET);
280         else
281                 lapic_send_eoi();
282 }
283
284 void
285 register_interrupt_handler(handler_t TP(TV(t)) table[],
286                            uint8_t int_num, poly_isr_t handler, TV(t) data)
287 {
288         table[int_num].isr = handler;
289         table[int_num].data = data;
290 }
291
292 void
293 page_fault_handler(trapframe_t *tf)
294 {
295         uint32_t fault_va;
296
297         // Read processor's CR2 register to find the faulting address
298         fault_va = rcr2();
299
300         // Handle kernel-mode page faults.
301
302         // TODO - one day, we'll want to handle this.
303         if ((tf->tf_cs & 3) == 0) {
304                 print_trapframe(tf);
305                 panic("Page Fault in the Kernel at 0x%08x!", fault_va);
306         }
307
308         // We've already handled kernel-mode exceptions, so if we get here,
309         // the page fault happened in user mode.
310
311         // Call the environment's page fault upcall, if one exists.  Set up a
312         // page fault stack frame on the user exception stack (below
313         // UXSTACKTOP), then branch to current->env_pgfault_upcall.
314         //
315         // The page fault upcall might cause another page fault, in which case
316         // we branch to the page fault upcall recursively, pushing another
317         // page fault stack frame on top of the user exception stack.
318         //
319         // The trap handler needs one word of scratch space at the top of the
320         // trap-time stack in order to return.  In the non-recursive case, we
321         // don't have to worry about this because the top of the regular user
322         // stack is free.  In the recursive case, this means we have to leave
323         // an extra word between the current top of the exception stack and
324         // the new stack frame because the exception stack _is_ the trap-time
325         // stack.
326         //
327         // If there's no page fault upcall, the environment didn't allocate a
328         // page for its exception stack, or the exception stack overflows,
329         // then destroy the environment that caused the fault.
330         //
331         // Hints:
332         //   user_mem_assert() and env_run() are useful here.
333         //   To change what the user environment runs, modify 'current->env_tf'
334         //   (the 'tf' variable points at 'current->env_tf').
335
336         // LAB 4: Your code here.
337
338         // Destroy the environment that caused the fault.
339         cprintf("[%08x] user fault va %08x ip %08x from core %d\n",
340                 current->env_id, fault_va, tf->tf_eip, core_id());
341         print_trapframe(tf);
342         proc_destroy(current);
343 }
344
345 void sysenter_init(void)
346 {
347         write_msr(MSR_IA32_SYSENTER_CS, GD_KT);
348         write_msr(MSR_IA32_SYSENTER_ESP, ts.ts_esp0);
349         write_msr(MSR_IA32_SYSENTER_EIP, (uint32_t) &sysenter_handler);
350 }
351
352 /* This is called from sysenter's asm, with the tf on the kernel stack. */
353 void sysenter_callwrapper(struct Trapframe *tf)
354 {
355         current->env_tf = *tf;
356
357         // The trapframe on the stack should be ignored from here on.
358         tf = &current->env_tf;
359         tf->tf_regs.reg_eax = (intreg_t) syscall(current,
360                                                  tf->tf_regs.reg_eax,
361                                                  tf->tf_regs.reg_edx,
362                                                  tf->tf_regs.reg_ecx,
363                                                  tf->tf_regs.reg_ebx,
364                                                  tf->tf_regs.reg_edi,
365                                                  0);
366         /*
367          * careful here - we need to make sure that this current is the right
368          * process, which could be weird if the syscall blocked.  it would need to
369          * restore the proper value in current before returning to here.
370          * likewise, tf could be pointing to random gibberish.
371          */
372         proc_startcore(current, tf);
373 }
374
375 uint32_t send_active_message(uint32_t dst, amr_t pc,
376                              TV(a0t) arg0, TV(a1t) arg1, TV(a2t) arg2)
377 {
378         error_t retval = -EBUSY;
379         spin_lock_irqsave(&per_cpu_info[dst].amsg_lock);
380         size_t current_amsg = per_cpu_info[dst].amsg_current;
381         // If there's a PC there, then that means it's an outstanding message
382         FOR_CIRC_BUFFER(current_amsg, NUM_ACTIVE_MESSAGES, i) {
383                 if (per_cpu_info[dst].active_msgs[i].pc)
384                         continue;
385                 per_cpu_info[dst].active_msgs[i].pc = pc;
386                 per_cpu_info[dst].active_msgs[i].arg0 = arg0;
387                 per_cpu_info[dst].active_msgs[i].arg1 = arg1;
388                 per_cpu_info[dst].active_msgs[i].arg2 = arg2;
389                 per_cpu_info[dst].active_msgs[i].srcid = core_id();
390                 retval = 0;
391                 break;
392         }
393         spin_unlock_irqsave(&per_cpu_info[dst].amsg_lock);
394         // since we touched memory the other core will touch (the lock), we don't
395         // need an wmb_f()
396         if (!retval)
397                 send_ipi(dst, 0, I_ACTIVE_MSG);
398         return retval;
399 }
400
401 /* Active message handler.  We don't want to block other AMs from coming in, so
402  * we'll copy out the message and let go of the lock.  This won't return until
403  * all pending AMs are executed.  If the PC is 0, then this was an extra IPI and
404  * we already handled the message (or someone is sending IPIs without loading
405  * the active message...)
406  * Note that all of this happens from interrupt context, and interrupts are
407  * currently disabled for this gate. */
408 void __active_message(trapframe_t *tf)
409 {
410         per_cpu_info_t RO*myinfo = &per_cpu_info[core_id()];
411         active_message_t amsg;
412
413         lapic_send_eoi();
414         while (1) { // will break out when we find an empty amsg
415                 /* Get the message */
416                 spin_lock_irqsave(&myinfo->amsg_lock);
417                 if (myinfo->active_msgs[myinfo->amsg_current].pc) {
418                         amsg = myinfo->active_msgs[myinfo->amsg_current];
419                         myinfo->active_msgs[myinfo->amsg_current].pc = 0;
420                         myinfo->amsg_current = (myinfo->amsg_current + 1) %
421                                                NUM_ACTIVE_MESSAGES;
422                 } else { // was no PC in the current active message, meaning we do nothing
423                         spin_unlock_irqsave(&myinfo->amsg_lock);
424                         return;
425                 }
426                 /* In case the function doesn't return (which is common: __startcore,
427                  * __death, etc), there is a chance we could lose an amsg.  We can only
428                  * have up to two interrupts outstanding, and if we never return, we
429                  * never deal with any other amsgs.  This extra IPI hurts performance
430                  * but is only necessary if there is another outstanding message in the
431                  * buffer, but makes sure we never miss out on an amsg. */
432                 if (myinfo->active_msgs[myinfo->amsg_current].pc)
433                         send_ipi(core_id(), 0, I_ACTIVE_MSG);
434                 spin_unlock_irqsave(&myinfo->amsg_lock);
435                 /* Execute the active message */
436                 amsg.pc(tf, amsg.srcid, amsg.arg0, amsg.arg1, amsg.arg2);
437         }
438 }