x86_64: kernel trap/interrupt handling
[akaros.git] / user / parlib / include / x86 / vcore64.h
1 #ifndef PARLIB_ARCH_VCORE64_H
2 #define PARLIB_ARCH_VCORE64_H
3
4 #ifndef PARLIB_ARCH_VCORE_H
5 #error "Do not include include vcore32.h directly"
6 #endif
7
8 #include <ros/common.h>
9 #include <ros/trapframe.h>
10 #include <ros/procdata.h>
11 #include <ros/syscall.h>
12 #include <ros/arch/mmu.h>
13 #include <sys/vcore-tls.h>
14
15 /* TODO 64b */
16 /* Here's how the HW popping works:  It sets up the future stack pointer to
17  * have extra stuff after it, and then it pops the registers, then pops the new
18  * context's stack pointer.  Then it uses the extra stuff (the new PC is on the
19  * stack, the location of notif_disabled, and a clobbered work register) to
20  * enable notifs, make sure notif IPIs weren't pending, restore the work reg,
21  * and then "ret".
22  *
23  * This is what the target uthread's stack will look like (growing down):
24  *
25  * Target ESP -> |   u_thread's old stuff   | the future %esp, tf->tf_esp
26  *               |   new eip                | 0x04 below %esp (one slot is 0x04)
27  *               |   eflags space           | 0x08 below
28  *               |   eax save space         | 0x0c below
29  *               |   actual syscall         | 0x10 below (0x30 space)
30  *               |   *sysc ptr to syscall   | 0x40 below (0x10 + 0x30)
31  *               |   notif_pending_loc      | 0x44 below (0x10 + 0x30)
32  *               |   notif_disabled_loc     | 0x48 below (0x10 + 0x30)
33  *
34  * The important thing is that it can handle a notification after it enables
35  * notifications, and when it gets resumed it can ultimately run the new
36  * context.  Enough state is saved in the running context and stack to continue
37  * running.
38  *
39  * Related to that is whether or not our stack pointer is sufficiently far down
40  * so that restarting *this* code won't clobber shit we need later.  The way we
41  * do this is that we do any "stack jumping" after we enable interrupts/notifs.
42  * These jumps are when we directly modify esp, specifically in the down
43  * direction (subtracts).  Adds would be okay.
44  *
45  * Another related concern is the storage for sysc.  It used to be on the
46  * vcore's stack, but if an interrupt comes in before we use it, we trash the
47  * vcore's stack (and thus the storage for sysc!).  Instead, we put it on the
48  * stack of the user tf.  Moral: don't touch a vcore's stack with notifs
49  * enabled. */
50
51 /* Helper for writing the info we need later to the u_tf's stack.  Note, this
52  * could get fucked if the struct syscall isn't a multiple of 4-bytes.  Also,
53  * note this goes backwards, since memory reads up the stack. */
54 struct restart_helper {
55         void                                            *notif_disab_loc;
56         void                                            *notif_pend_loc;
57         struct syscall                          *sysc;
58         struct syscall                          local_sysc;     /* unused for now */
59         uint32_t                                        eax_save;
60         uint32_t                                        eflags;
61         uint32_t                                        eip;
62 };
63
64 /* Static syscall, used for self-notifying.  We never wait on it, and we
65  * actually might submit it multiple times in parallel on different cores!
66  * While this may seem dangerous, the kernel needs to be able to handle this
67  * scenario.  It's also important that we never wait on this, since for all but
68  * the first call, the DONE flag will be set.  (Set once, then never reset) */
69 extern struct syscall vc_entry; /* in x86/vcore.c */
70
71 static inline void pop_hw_tf(struct hw_trapframe *tf, uint32_t vcoreid)
72 {
73         #if 0
74         struct restart_helper *rst;
75         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
76         if (!tf->tf_cs) { /* sysenter TF.  esp and eip are in other regs. */
77                 tf->tf_esp = tf->tf_regs.reg_ebp;
78                 tf->tf_eip = tf->tf_regs.reg_edx;
79         }
80         /* The stuff we need to write will be below the current stack of the utf */
81         rst = (struct restart_helper*)((void*)tf->tf_esp -
82                                        sizeof(struct restart_helper));
83         /* Fill in the info we'll need later */
84         rst->notif_disab_loc = &vcpd->notif_disabled;
85         rst->notif_pend_loc = &vcpd->notif_pending;
86         rst->sysc = &vc_entry;
87         rst->eax_save = 0;                      /* avoid bugs */
88         rst->eflags = tf->tf_eflags;
89         rst->eip = tf->tf_eip;
90
91         asm volatile ("movl %0,%%esp;        " /* jump esp to the utf */
92                       "popal;                " /* restore normal registers */
93                       "addl $0x24,%%esp;     " /* move to the esp slot in the tf */
94                       "popl %%esp;           " /* change to the utf's %esp */
95                       "subl $0x08,%%esp;     " /* move esp to below eax's slot */
96                       "pushl %%eax;          " /* save eax, will clobber soon */
97                                   "movl %2,%%eax;        " /* sizeof struct syscall */
98                                   "addl $0x0c,%%eax;     " /* more offset btw eax/notif_en_loc*/
99                       "subl %%eax,%%esp;     " /* move to notif_en_loc slot */
100                       "popl %%eax;           " /* load notif_disabled addr */
101                       "movb $0x00,(%%eax);   " /* enable notifications */
102                                   /* Need a wrmb() here so the write of enable_notif can't pass
103                                    * the read of notif_pending (racing with a potential
104                                    * cross-core call with proc_notify()). */
105                                   "lock addl $0,(%%esp); " /* LOCK is a CPU mb() */
106                                   /* From here down, we can get interrupted and restarted */
107                       "popl %%eax;           " /* get notif_pending status */
108                       "testb $0x01,(%%eax);  " /* test if a notif is pending */
109                       "jz 1f;                " /* if not pending, skip syscall */
110                                   /* Actual syscall.  Note we don't wait on the async call */
111                       "popl %%eax;           " /* &sysc, trap arg0 */
112                       "pushl %%edx;          " /* save edx, will be trap arg1 */
113                       "movl $0x1,%%edx;      " /* sending one async syscall: arg1 */
114                       "int %1;               " /* fire the syscall */
115                       "popl %%edx;           " /* restore regs after syscall */
116                       "jmp 2f;               " /* skip 1:, already popped */
117                                   "1: popl %%eax;        " /* discard &sysc (on non-sc path) */
118                       "2: addl %2,%%esp;     " /* jump over the sysc (both paths) */
119                       "popl %%eax;           " /* restore tf's %eax */
120                                   "popfl;                " /* restore utf's eflags */
121                       "ret;                  " /* return to the new PC */
122                       :
123                       : "g"(tf), "i"(T_SYSCALL), "i"(sizeof(struct syscall))
124                       : "memory");
125         #endif
126 }
127
128 static inline void pop_sw_tf(struct sw_trapframe *sw_tf, uint32_t vcoreid)
129 {
130         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
131
132         #if 0
133         /* Restore callee-saved FPU state.  We need to clear exceptions before
134          * reloading the FP CW, in case the new CW unmasks any.  We also need to
135          * reset the tag word to clear out the stack.
136          *
137          * The main issue here is that while our context was saved in an
138          * ABI-complaint manner, we may be starting up on a somewhat random FPU
139          * state.  Having gibberish in registers isn't a big deal, but some of the
140          * FP environment settings could cause trouble.  If fnclex; emms isn't
141          * enough, we could also save/restore the entire FP env with fldenv, or do
142          * an fninit before fldcw. */
143         asm volatile ("ldmxcsr %0" : : "m"(sw_tf->tf_mxcsr));
144         asm volatile ("fnclex; emms; fldcw %0" : : "m"(sw_tf->tf_fpucw));
145         /* Basic plan: restore all regs, off ecx as the sw_tf.  Switch to the new
146          * stack, push the PC so we can pop it later.  Use eax and edx for the
147          * locations of sysc and vcpd.  Once on the new stack, we enable notifs,
148          * check if we missed one, and if so, self notify. */
149         asm volatile ("movl 0x00(%0),%%ebp;  " /* restore regs */
150                       "movl 0x04(%0),%%ebx;  "
151                       "movl 0x08(%0),%%esi;  "
152                       "movl 0x0c(%0),%%edi;  "
153                       "movl 0x10(%0),%%esp;  " /* jump to future stack */
154                       "pushl 0x14(%0);       " /* save PC for future ret */
155                       "movl %2,%%ecx;        " /* vcpd loc into ecx */
156                       "addl %4,%%ecx;        " /* notif_disabled loc into ecx */
157                       "movb $0x00,(%%ecx);   " /* enable notifications */
158                       /* Need a wrmb() here so the write of enable_notif can't pass
159                        * the read of notif_pending (racing with a potential
160                        * cross-core call with proc_notify()). */
161                       "lock addl $0,(%%esp); " /* LOCK is a CPU mb() */
162                       /* From here down, we can get interrupted and restarted */
163                       "movl %2,%%ecx;        " /* vcpd loc into ecx */
164                       "addl %5,%%ecx;        " /* notif_pending loc into ecx */
165                       "testb $0x01,(%%ecx);  " /* test if a notif is pending */
166                       "jz 1f;                " /* if not pending, skip syscall */
167                       /* Actual syscall.  Note we don't wait on the async call.
168                        * &sysc is already in eax (trap arg0). */
169                       "movl $0x1,%%edx;      " /* sending one async syscall: arg1 */
170                       "int %3;               " /* fire the syscall */
171                       "1: ret;               " /* retaddr was pushed earlier */
172                       :
173                       : "c"(sw_tf),
174                         "a"(&vc_entry),
175                         "d"(vcpd),
176                         "i"(T_SYSCALL),
177                         "i"(offsetof(struct preempt_data, notif_disabled)),
178                         "i"(offsetof(struct preempt_data, notif_pending))
179                       : "memory");
180         #endif
181 }
182
183 /* Pops a user context, reanabling notifications at the same time.  A Userspace
184  * scheduler can call this when transitioning off the transition stack.
185  *
186  * At some point in vcore context before calling this, you need to clear
187  * notif_pending (do this by calling handle_events()).  As a potential
188  * optimization, consider clearing the notif_pending flag / handle_events again
189  * (right before popping), right before calling this.  If notif_pending is not
190  * clear, this will self_notify this core, since it should be because we missed
191  * a notification message while notifs were disabled. */
192 static inline void pop_user_ctx(struct user_context *ctx, uint32_t vcoreid)
193 {
194         if (ctx->type == ROS_HW_CTX)
195                 pop_hw_tf(&ctx->tf.hw_tf, vcoreid);
196         else
197                 pop_sw_tf(&ctx->tf.sw_tf, vcoreid);
198 }
199
200 /* Like the regular pop_user_ctx, but this one doesn't check or clear
201  * notif_pending.  The only case where we use this is when an IRQ/notif
202  * interrupts a uthread that is in the process of disabling notifs. */
203 static inline void pop_user_ctx_raw(struct user_context *ctx, uint32_t vcoreid)
204 {
205         #if 0
206         struct hw_trapframe *tf = &ctx->tf.hw_tf;
207         assert(ctx->type == ROS_HW_CTX);
208         struct restart_helper *rst;
209         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
210         if (!tf->tf_cs) { /* sysenter TF.  esp and eip are in other regs. */
211                 tf->tf_esp = tf->tf_regs.reg_ebp;
212                 tf->tf_eip = tf->tf_regs.reg_edx;
213         }
214         /* The stuff we need to write will be below the current stack of the utf */
215         rst = (struct restart_helper*)((void*)tf->tf_esp -
216                                        sizeof(struct restart_helper));
217         /* Fill in the info we'll need later */
218         rst->notif_disab_loc = &vcpd->notif_disabled;
219         rst->eax_save = 0;                      /* avoid bugs */
220         rst->eflags = tf->tf_eflags;
221         rst->eip = tf->tf_eip;
222
223         asm volatile ("movl %0,%%esp;        " /* jump esp to the utf */
224                       "popal;                " /* restore normal registers */
225                       "addl $0x24,%%esp;     " /* move to the esp slot in the tf */
226                       "popl %%esp;           " /* change to the utf's %esp */
227                       "subl $0x08,%%esp;     " /* move esp to below eax's slot */
228                       "pushl %%eax;          " /* save eax, will clobber soon */
229                                   "movl %2,%%eax;        " /* sizeof struct syscall */
230                                   "addl $0x0c,%%eax;     " /* more offset btw eax/notif_en_loc*/
231                       "subl %%eax,%%esp;     " /* move to notif_en_loc slot */
232                       "popl %%eax;           " /* load notif_disabled addr */
233                       "movb $0x00,(%%eax);   " /* enable notifications */
234                                   /* Here's where we differ from the regular pop_user_ctx().
235                                    * We do the same pops/esp moves, just to keep things similar
236                                    * and simple, but don't do test, clear notif_pending, or
237                                    * call a syscall. */
238                                   /* From here down, we can get interrupted and restarted */
239                       "popl %%eax;           " /* get notif_pending status */
240                                   "popl %%eax;           " /* discard &sysc (on non-sc path) */
241                       "addl %2,%%esp;        " /* jump over the sysc (both paths) */
242                       "popl %%eax;           " /* restore tf's %eax */
243                                   "popfl;                " /* restore utf's eflags */
244                       "ret;                  " /* return to the new PC */
245                       :
246                       : "g"(tf), "i"(T_SYSCALL), "i"(sizeof(struct syscall))
247                       : "memory");
248         #endif
249 }
250
251 /* Save's a SW context, setting the PC to the end of this function.  We only
252  * save callee-saved registers (of the sysv abi).  The compiler knows to save
253  * the others via the input/clobber lists.
254  *
255  * Callers of this function need to have at least one
256  * 'calling-convention-compliant' function call between this and any floating
257  * point, so that the compiler saves any caller-saved FP before getting to
258  * here.
259  *
260  * To some extent, TLS is 'callee-saved', in that no one ever expects it to
261  * change.  We handle uthread TLS changes separately, since we often change to
262  * them early to set some variables.  Arguably we should do this different. */
263 static inline void save_user_ctx(struct user_context *ctx)
264 {
265         #if 0
266         struct sw_trapframe *sw_tf = &ctx->tf.sw_tf;
267         ctx->type = ROS_SW_CTX;
268         asm volatile ("stmxcsr %0" : "=m"(sw_tf->tf_mxcsr));
269         asm volatile ("fnstcw %0" : "=m"(sw_tf->tf_fpucw));
270         /* Pretty simple: save all the regs, IAW the sys-v ABI */
271         asm volatile ("movl %%ebp,0x00(%0);   "
272                       "movl %%ebx,0x04(%0);   "
273                       "movl %%esi,0x08(%0);   "
274                       "movl %%edi,0x0c(%0);   "
275                       "movl %%esp,0x10(%0);   "
276                       "leal 1f,%%eax;         " /* get future eip */
277                       "movl %%eax,0x14(%0);   "
278                       "1:                     " /* where this tf will restart */
279                       :
280                       : "c"(sw_tf)
281                       : "eax", "edx", "memory", "cc");
282         #endif
283 }
284
285 /* The old version, kept around for testing */
286 static inline void save_user_ctx_hw(struct user_context *ctx)
287 {
288         #if 0
289         struct hw_trapframe *tf = &ctx->tf.hw_tf;
290         ctx->type = ROS_HW_CTX;
291         memset(tf, 0, sizeof(struct hw_trapframe)); /* sanity */
292         /* set CS and make sure eflags is okay */
293         tf->tf_cs = GD_UT | 3;
294         tf->tf_eflags = 0x00000200; /* interrupts enabled.  bare minimum eflags. */
295         /* Save the regs and the future esp. */
296         asm volatile("movl %%esp,(%0);       " /* save esp in it's slot*/
297                      "pushl %%eax;           " /* temp save eax */
298                      "leal 1f,%%eax;         " /* get future eip */
299                      "movl %%eax,(%1);       " /* store future eip */
300                      "popl %%eax;            " /* restore eax */
301                      "movl %2,%%esp;         " /* move to the beginning of the tf */
302                      "addl $0x20,%%esp;      " /* move to after the push_regs */
303                      "pushal;                " /* save regs */
304                      "addl $0x44,%%esp;      " /* move to esp slot */
305                      "popl %%esp;            " /* restore esp */
306                      "1:                     " /* where this tf will restart */
307                      : 
308                      : "g"(&tf->tf_esp), "g"(&tf->tf_eip), "g"(tf)
309                      : "eax", "memory", "cc");
310         #endif
311 }
312
313 static inline void init_user_ctx(struct user_context *ctx, uint32_t entry_pt,
314                                  uint32_t stack_top)
315 {
316         #if 0
317         struct sw_trapframe *sw_tf = &ctx->tf.sw_tf;
318         ctx->type = ROS_SW_CTX;
319         /* No need to bother with setting the other GP registers; the called
320          * function won't care about their contents. */
321         sw_tf->tf_esp = stack_top;
322         sw_tf->tf_eip = entry_pt;
323         sw_tf->tf_mxcsr = 0x00001f80;   /* x86 default mxcsr */
324         sw_tf->tf_fpucw = 0x037f;               /* x86 default FP CW */
325         #endif
326 }
327
328 // this is how we get our thread id on entry.
329 #define __vcore_id_on_entry \
330 ({ \
331         register int temp asm ("eax"); \
332         temp; \
333 })
334
335 /* For debugging. */
336 #include <stdio.h>
337 static void print_hw_tf(struct hw_trapframe *tf)
338 {
339         #if 0
340         printf("[user] HW TRAP frame %08p\n", tf);
341         printf("  edi  0x%08x\n", tf->tf_regs.reg_edi);
342         printf("  esi  0x%08x\n", tf->tf_regs.reg_esi);
343         printf("  ebp  0x%08x\n", tf->tf_regs.reg_ebp);
344         printf("  oesp 0x%08x\n", tf->tf_regs.reg_oesp);
345         printf("  ebx  0x%08x\n", tf->tf_regs.reg_ebx);
346         printf("  edx  0x%08x\n", tf->tf_regs.reg_edx);
347         printf("  ecx  0x%08x\n", tf->tf_regs.reg_ecx);
348         printf("  eax  0x%08x\n", tf->tf_regs.reg_eax);
349         printf("  gs   0x----%04x\n", tf->tf_gs);
350         printf("  fs   0x----%04x\n", tf->tf_fs);
351         printf("  es   0x----%04x\n", tf->tf_es);
352         printf("  ds   0x----%04x\n", tf->tf_ds);
353         printf("  trap 0x%08x\n", tf->tf_trapno);
354         printf("  err  0x%08x\n", tf->tf_err);
355         printf("  eip  0x%08x\n", tf->tf_eip);
356         printf("  cs   0x----%04x\n", tf->tf_cs);
357         printf("  flag 0x%08x\n", tf->tf_eflags);
358         printf("  esp  0x%08x\n", tf->tf_esp);
359         printf("  ss   0x----%04x\n", tf->tf_ss);
360         #endif
361 }
362
363 static void print_sw_tf(struct sw_trapframe *sw_tf)
364 {
365         #if 0
366         printf("[user] SW TRAP frame %08p\n", sw_tf);
367         printf("  ebp  0x%08x\n", sw_tf->tf_ebp);
368         printf("  ebx  0x%08x\n", sw_tf->tf_ebx);
369         printf("  esi  0x%08x\n", sw_tf->tf_esi);
370         printf("  edi  0x%08x\n", sw_tf->tf_edi);
371         printf("  esp  0x%08x\n", sw_tf->tf_esp);
372         printf("  eip  0x%08x\n", sw_tf->tf_eip);
373         printf(" mxcsr 0x%08x\n", sw_tf->tf_mxcsr);
374         printf(" fpucw 0x----%04x\n", sw_tf->tf_fpucw);
375         #endif
376 }
377
378 static void print_user_context(struct user_context *ctx)
379 {
380         if (ctx->type == ROS_HW_CTX)
381                 print_hw_tf(&ctx->tf.hw_tf);
382         else if (ctx->type == ROS_SW_CTX)
383                 print_sw_tf(&ctx->tf.sw_tf);
384         else
385                 printf("Unknown context type %d\n", ctx->type);
386 }
387
388 #endif /* PARLIB_ARCH_VCORE64_H */