5a4e8ab05b5439c731664162d74fa540b3910b14
[akaros.git] / user / parlib / x86 / vcore.c
1 #include <ros/syscall.h>
2 #include <parlib/vcore.h>
3 #include <parlib/stdio.h>
4 #include <stdlib.h>
5
6 /* Here's how the HW popping works:  It sets up the future stack pointer to
7  * have extra stuff after it, and then it pops the registers, then pops the new
8  * context's stack pointer.  Then it uses the extra stuff (the new PC is on the
9  * stack, the location of notif_disabled, and a clobbered work register) to
10  * enable notifs, make sure notif IPIs weren't pending, restore the work reg,
11  * and then "ret".
12  *
13  * However, we can't just put the extra stuff directly below the rsp.  We need
14  * to leave room for the redzone: area that is potentially being used.  (Even if
15  * you compile with -mno-red-zone, some asm code (glibc memcpy) will still use
16  * that area).
17  *
18  * This is what the target uthread's stack will look like (growing down):
19  *
20  * Target RSP -> |   u_thread's old stuff   | the future %rsp, tf->tf_rsp
21  *               |            .             | beginning of Red Zone
22  *               |            .             |
23  *               |   128 Bytes of Red Zone  |
24  *               |            .             |
25  *               |            .             | end of Red Zone
26  *               |   new rip                | 0x08 below Red (one slot is 0x08)
27  *               |   rflags space           | 0x10 below
28  *               |   rdi save space         | 0x18 below
29  *               |   *sysc ptr to syscall   | 0x20 below
30  *               |   notif_pending_loc      | 0x28 below
31  *               |   notif_disabled_loc     | 0x30 below
32  *
33  * The important thing is that it can handle a notification after it enables
34  * notifications, and when it gets resumed it can ultimately run the new
35  * context.  Enough state is saved in the running context and stack to continue
36  * running.
37  *
38  * Related to that is whether or not our stack pointer is sufficiently far down
39  * so that restarting *this* code won't clobber shit we need later.  The way we
40  * do this is that we do any "stack jumping" before we enable interrupts/notifs.
41  * These jumps are when we directly modify rsp, specifically in the down
42  * direction (subtracts).  Adds would be okay. */
43
44 /* Helper for writing the info we need later to the u_tf's stack.  Also, note
45  * this goes backwards, since memory reads up the stack. */
46 struct restart_helper {
47         void                                            *notif_disab_loc;
48         void                                            *notif_pend_loc;
49         struct syscall                          *sysc;
50         uint64_t                                        rdi_save;
51         uint64_t                                        rflags;
52         uint64_t                                        rip;
53 };
54
55 /* Static syscall, used for self-notifying.  We never wait on it, and we
56  * actually might submit it multiple times in parallel on different cores!
57  * While this may seem dangerous, the kernel needs to be able to handle this
58  * scenario.  It's also important that we never wait on this, since for all but
59  * the first call, the DONE flag will be set.  (Set once, then never reset) */
60 struct syscall vc_entry = {
61         .num = SYS_vc_entry,
62         .err = 0,
63         .retval = 0,
64         .flags = 0,
65         .ev_q = 0,
66         .u_data = 0,
67         .arg0 = 0,
68         .arg1 = 0,
69         .arg2 = 0,
70         .arg3 = 0,
71         .arg4 = 0,
72         .arg5 = 0,
73 };
74
75 static void pop_hw_tf(struct hw_trapframe *tf, uint32_t vcoreid)
76 {
77         #define X86_RED_ZONE_SZ                 128
78         struct restart_helper *rst;
79         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
80
81         /* The stuff we need to write will be below the current stack and red zone
82          * of the utf */
83         rst = (struct restart_helper*)((void*)tf->tf_rsp - X86_RED_ZONE_SZ -
84                                        sizeof(struct restart_helper));
85         /* Fill in the info we'll need later */
86         rst->notif_disab_loc = &vcpd->notif_disabled;
87         rst->notif_pend_loc = &vcpd->notif_pending;
88         rst->sysc = &vc_entry;
89         rst->rdi_save = 0;                      /* avoid bugs */
90         rst->rflags = tf->tf_rflags;
91         rst->rip = tf->tf_rip;
92
93         asm volatile ("movq %0, %%rsp;       " /* jump rsp to the utf */
94                       "popq %%rax;           " /* restore registers */
95                       "popq %%rbx;           "
96                       "popq %%rcx;           "
97                       "popq %%rdx;           "
98                       "popq %%rbp;           "
99                       "popq %%rsi;           "
100                       "popq %%rdi;           "
101                       "popq %%r8;            "
102                       "popq %%r9;            "
103                       "popq %%r10;           "
104                       "popq %%r11;           "
105                       "popq %%r12;           "
106                       "popq %%r13;           "
107                       "popq %%r14;           "
108                       "popq %%r15;           "
109                       "addq $0x28, %%rsp;    " /* move to the rsp slot in the tf */
110                       "popq %%rsp;           " /* change to the utf's %rsp */
111                       "subq %[red], %%rsp;   " /* jump over the redzone */
112                       "subq $0x10, %%rsp;    " /* move rsp to below rdi's slot */
113                       "pushq %%rdi;          " /* save rdi, will clobber soon */
114                       "subq $0x18, %%rsp;    " /* move to notif_dis_loc slot */
115                       "popq %%rdi;           " /* load notif_disabled addr */
116                       "movb $0x00, (%%rdi);  " /* enable notifications */
117                                   /* Need a wrmb() here so the write of enable_notif can't pass
118                                    * the read of notif_pending (racing with a potential
119                                    * cross-core call with proc_notify()). */
120                                   "lock addb $0, (%%rdi);" /* LOCK is a CPU mb() */
121                                   /* From here down, we can get interrupted and restarted */
122                       "popq %%rdi;           " /* get notif_pending status loc */
123                       "testb $0x01, (%%rdi); " /* test if a notif is pending */
124                       "jz 1f;                " /* if not pending, skip syscall */
125                                   /* Actual syscall.  Note we don't wait on the async call */
126                       "popq %%rdi;           " /* &sysc, trap arg0 */
127                       "pushq %%rsi;          " /* save rax, will be trap arg1 */
128                       "pushq %%rax;          " /* save rax, will be trap ret */
129                       "movq $0x1, %%rsi;     " /* sending one async syscall: arg1 */
130                       "int %1;               " /* fire the syscall */
131                       "popq %%rax;           " /* restore regs after syscall */
132                       "popq %%rsi;           "
133                       "jmp 2f;               " /* skip 1:, already popped */
134                                   "1: addq $0x08, %%rsp; " /* discard &sysc (on non-sc path) */
135                       "2: popq %%rdi;        " /* restore tf's %rdi (both paths) */
136                                   "popfq;                " /* restore utf's rflags */
137                       "ret %[red];           " /* return to the new PC, skip red */
138                       :
139                       : "g"(&tf->tf_rax), "i"(T_SYSCALL), [red]"i"(X86_RED_ZONE_SZ)
140                       : "memory");
141 }
142
143 static void pop_sw_tf(struct sw_trapframe *sw_tf, uint32_t vcoreid)
144 {
145         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
146
147         /* Restore callee-saved FPU state.  We need to clear exceptions before
148          * reloading the FP CW, in case the new CW unmasks any.  We also need to
149          * reset the tag word to clear out the stack.
150          *
151          * The main issue here is that while our context was saved in an
152          * ABI-complaint manner, we may be starting up on a somewhat random FPU
153          * state.  Having gibberish in registers isn't a big deal, but some of the
154          * FP environment settings could cause trouble.  If fnclex; emms isn't
155          * enough, we could also save/restore the entire FP env with fldenv, or do
156          * an fninit before fldcw. */
157         asm volatile ("ldmxcsr %0" : : "m"(sw_tf->tf_mxcsr));
158         asm volatile ("fnclex; emms; fldcw %0" : : "m"(sw_tf->tf_fpucw));
159         /* Basic plan: restore all regs, off rcx as the sw_tf.  Switch to the new
160          * stack, save the PC so we can jump to it later.  Use clobberably
161          * registers for the locations of sysc, notif_dis, and notif_pend. Once on
162          * the new stack, we enable notifs, check if we missed one, and if so, self
163          * notify.  Note the syscall clobbers rax. */
164         asm volatile ("movq 0x00(%0), %%rbx; " /* restore regs */
165                       "movq 0x08(%0), %%rbp; "
166                       "movq 0x10(%0), %%r12; "
167                       "movq 0x18(%0), %%r13; "
168                       "movq 0x20(%0), %%r14; "
169                       "movq 0x28(%0), %%r15; "
170                       "movq 0x30(%0), %%r8;  " /* save rip in r8 */
171                       "movq 0x38(%0), %%rsp; " /* jump to future stack */
172                       "movb $0x00, (%2);     " /* enable notifications */
173                       /* Need a wrmb() here so the write of enable_notif can't pass
174                        * the read of notif_pending (racing with a potential
175                        * cross-core call with proc_notify()). */
176                       "lock addb $0, (%2);   " /* LOCK is a CPU mb() */
177                       /* From here down, we can get interrupted and restarted */
178                       "testb $0x01, (%3);    " /* test if a notif is pending */
179                       "jz 1f;                " /* if not pending, skip syscall */
180                       /* Actual syscall.  Note we don't wait on the async call.
181                        * &vc_entry is already in rdi (trap arg0). */
182                       "movq $0x1, %%rsi;     " /* sending one async syscall: arg1 */
183                       "int %4;               " /* fire the syscall */
184                       "1: jmp *%%r8;         " /* ret saved earlier */
185                       :
186                       : "c"(&sw_tf->tf_rbx),
187                         "D"(&vc_entry),
188                         "S"(&vcpd->notif_disabled),
189                         "d"(&vcpd->notif_pending),
190                         "i"(T_SYSCALL)
191                       : "memory");
192 }
193
194 /* Pops a user context, reanabling notifications at the same time.  A Userspace
195  * scheduler can call this when transitioning off the transition stack.
196  *
197  * pop_user_ctx will fail if we have a notif_pending; you're not allowed to
198  * leave vcore context with notif_pending set.  Some code in vcore_entry
199  * needs clear notif_pending and check whatever might have caused a notif
200  * (e.g. call handle_events()).
201  *
202  * If notif_pending is not clear, this will self_notify this core, since it
203  * should be because we missed a notification message while notifs were
204  * disabled. */
205 void pop_user_ctx(struct user_context *ctx, uint32_t vcoreid)
206 {
207         struct preempt_data *vcpd = vcpd_of(vcoreid);
208
209         /* We check early for notif_pending, since if we deal with it during
210          * pop_hw_tf, we grow the stack slightly.  If a thread consistently fails to
211          * restart due to notif pending, it will eventually run off the bottom of
212          * its stack.  By performing the check here, we shrink that window.  You'd
213          * have to have a notif come after this check, but also *not* before this
214          * check.  If you PF in pop_user_ctx, this all failed. */
215         if (vcpd->notif_pending) {
216                 /* if pop_user_ctx fails (and resets the vcore), the ctx contents must
217                  * be in VCPD (due to !UTHREAD_SAVED).  it might already be there. */
218                 if (ctx != &vcpd->uthread_ctx)
219                         vcpd->uthread_ctx = *ctx;
220                 /* To restart the vcore, we must have the right TLS, stack pointer, and
221                  * vc_ctx = TRUE. */
222                 set_tls_desc((void*)vcpd->vcore_tls_desc);
223                 begin_safe_access_tls_vars()
224                 __vcore_context = TRUE;
225                 end_safe_access_tls_vars()
226                 set_stack_pointer((void*)vcpd->vcore_stack);
227                 vcore_entry();
228         }
229         switch (ctx->type) {
230         case ROS_HW_CTX:
231                 pop_hw_tf(&ctx->tf.hw_tf, vcoreid);
232                 break;
233         case ROS_SW_CTX:
234                 pop_sw_tf(&ctx->tf.sw_tf, vcoreid);
235                 break;
236         case ROS_VM_CTX:
237                 ros_syscall(SYS_pop_ctx, ctx, 0, 0, 0, 0, 0);
238                 break;
239         }
240         assert(0);
241 }
242
243 /* Like the regular pop_user_ctx, but this one doesn't check or clear
244  * notif_pending.  The only case where we use this is when an IRQ/notif
245  * interrupts a uthread that is in the process of disabling notifs.
246  *
247  * If we need to support VM_CTXs here, we'll need to tell the kernel whether or
248  * not we want to enable_notifs (flag to SYS_pop_ctx).  The only use case for
249  * this is when disabling notifs.  Currently, a VM can't do this or do things
250  * like uthread_yield.  It doesn't have access to the vcore's or uthread's TLS
251  * to bootstrap any of that stuff. */
252 void pop_user_ctx_raw(struct user_context *ctx, uint32_t vcoreid)
253 {
254         struct hw_trapframe *tf = &ctx->tf.hw_tf;
255         struct restart_helper *rst;
256         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
257
258         assert(ctx->type == ROS_HW_CTX);
259         /* The stuff we need to write will be below the current stack of the utf */
260         rst = (struct restart_helper*)((void*)tf->tf_rsp -
261                                        sizeof(struct restart_helper));
262         /* Fill in the info we'll need later */
263         rst->notif_disab_loc = &vcpd->notif_disabled;
264         rst->rdi_save = 0;                      /* avoid bugs */
265         rst->rflags = tf->tf_rflags;
266         rst->rip = tf->tf_rip;
267
268         asm volatile ("movq %0, %%rsp;       " /* jump esp to the utf */
269                       "popq %%rax;           " /* restore registers */
270                       "popq %%rbx;           "
271                       "popq %%rcx;           "
272                       "popq %%rdx;           "
273                       "popq %%rbp;           "
274                       "popq %%rsi;           "
275                       "popq %%rdi;           "
276                       "popq %%r8;            "
277                       "popq %%r9;            "
278                       "popq %%r10;           "
279                       "popq %%r11;           "
280                       "popq %%r12;           "
281                       "popq %%r13;           "
282                       "popq %%r14;           "
283                       "popq %%r15;           "
284                       "addq $0x28, %%rsp;    " /* move to the rsp slot in the tf */
285                       "popq %%rsp;           " /* change to the utf's %rsp */
286                       "subq $0x10, %%rsp;    " /* move rsp to below rdi's slot */
287                       "pushq %%rdi;          " /* save rdi, will clobber soon */
288                       "subq $0x18, %%rsp;    " /* move to notif_dis_loc slot */
289                       "popq %%rdi;           " /* load notif_disabled addr */
290                       "movb $0x00, (%%rdi);  " /* enable notifications */
291                                   /* Here's where we differ from the regular pop_user_ctx().
292                                    * We need to adjust rsp and whatnot, but don't do test,
293                                    * clear notif_pending, or call a syscall. */
294                                   /* From here down, we can get interrupted and restarted */
295                       "addq $0x10, %%rsp;    " /* move to rdi save slot */
296                       "popq %%rdi;           " /* restore tf's %rdi */
297                                   "popfq;                " /* restore utf's rflags */
298                       "ret;                  " /* return to the new PC */
299                       :
300                       : "g"(&tf->tf_rax)
301                       : "memory");
302 }
303
304 void print_hw_tf(struct hw_trapframe *hw_tf)
305 {
306         printf("[user] HW TRAP frame 0x%016x\n", hw_tf);
307         printf("  rax  0x%016lx\n",           hw_tf->tf_rax);
308         printf("  rbx  0x%016lx\n",           hw_tf->tf_rbx);
309         printf("  rcx  0x%016lx\n",           hw_tf->tf_rcx);
310         printf("  rdx  0x%016lx\n",           hw_tf->tf_rdx);
311         printf("  rbp  0x%016lx\n",           hw_tf->tf_rbp);
312         printf("  rsi  0x%016lx\n",           hw_tf->tf_rsi);
313         printf("  rdi  0x%016lx\n",           hw_tf->tf_rdi);
314         printf("  r8   0x%016lx\n",           hw_tf->tf_r8);
315         printf("  r9   0x%016lx\n",           hw_tf->tf_r9);
316         printf("  r10  0x%016lx\n",           hw_tf->tf_r10);
317         printf("  r11  0x%016lx\n",           hw_tf->tf_r11);
318         printf("  r12  0x%016lx\n",           hw_tf->tf_r12);
319         printf("  r13  0x%016lx\n",           hw_tf->tf_r13);
320         printf("  r14  0x%016lx\n",           hw_tf->tf_r14);
321         printf("  r15  0x%016lx\n",           hw_tf->tf_r15);
322         printf("  trap 0x%08x\n",             hw_tf->tf_trapno);
323         printf("  gsbs 0x%016lx\n",           hw_tf->tf_gsbase);
324         printf("  fsbs 0x%016lx\n",           hw_tf->tf_fsbase);
325         printf("  err  0x--------%08x\n",     hw_tf->tf_err);
326         printf("  rip  0x%016lx\n",           hw_tf->tf_rip);
327         printf("  cs   0x------------%04x\n", hw_tf->tf_cs);
328         printf("  flag 0x%016lx\n",           hw_tf->tf_rflags);
329         printf("  rsp  0x%016lx\n",           hw_tf->tf_rsp);
330         printf("  ss   0x------------%04x\n", hw_tf->tf_ss);
331 }
332
333 void print_sw_tf(struct sw_trapframe *sw_tf)
334 {
335         printf("[user] SW TRAP frame 0x%016p\n", sw_tf);
336         printf("  rbx  0x%016lx\n",           sw_tf->tf_rbx);
337         printf("  rbp  0x%016lx\n",           sw_tf->tf_rbp);
338         printf("  r12  0x%016lx\n",           sw_tf->tf_r12);
339         printf("  r13  0x%016lx\n",           sw_tf->tf_r13);
340         printf("  r14  0x%016lx\n",           sw_tf->tf_r14);
341         printf("  r15  0x%016lx\n",           sw_tf->tf_r15);
342         printf("  gsbs 0x%016lx\n",           sw_tf->tf_gsbase);
343         printf("  fsbs 0x%016lx\n",           sw_tf->tf_fsbase);
344         printf("  rip  0x%016lx\n",           sw_tf->tf_rip);
345         printf("  rsp  0x%016lx\n",           sw_tf->tf_rsp);
346         printf(" mxcsr 0x%08x\n",             sw_tf->tf_mxcsr);
347         printf(" fpucw 0x%04x\n",             sw_tf->tf_fpucw);
348 }
349
350 void print_vm_tf(struct vm_trapframe *vm_tf)
351 {
352         printf("[user] VM Trapframe 0x%016x\n", vm_tf);
353         printf("  rax  0x%016lx\n",           vm_tf->tf_rax);
354         printf("  rbx  0x%016lx\n",           vm_tf->tf_rbx);
355         printf("  rcx  0x%016lx\n",           vm_tf->tf_rcx);
356         printf("  rdx  0x%016lx\n",           vm_tf->tf_rdx);
357         printf("  rbp  0x%016lx\n",           vm_tf->tf_rbp);
358         printf("  rsi  0x%016lx\n",           vm_tf->tf_rsi);
359         printf("  rdi  0x%016lx\n",           vm_tf->tf_rdi);
360         printf("  r8   0x%016lx\n",           vm_tf->tf_r8);
361         printf("  r9   0x%016lx\n",           vm_tf->tf_r9);
362         printf("  r10  0x%016lx\n",           vm_tf->tf_r10);
363         printf("  r11  0x%016lx\n",           vm_tf->tf_r11);
364         printf("  r12  0x%016lx\n",           vm_tf->tf_r12);
365         printf("  r13  0x%016lx\n",           vm_tf->tf_r13);
366         printf("  r14  0x%016lx\n",           vm_tf->tf_r14);
367         printf("  r15  0x%016lx\n",           vm_tf->tf_r15);
368         printf("  rip  0x%016lx\n",           vm_tf->tf_rip);
369         printf("  rflg 0x%016lx\n",           vm_tf->tf_rflags);
370         printf("  rsp  0x%016lx\n",           vm_tf->tf_rsp);
371         printf("  cr2  0x%016lx\n",           vm_tf->tf_cr2);
372         printf("  cr3  0x%016lx\n",           vm_tf->tf_cr3);
373         printf("Gpcore 0x%08x\n",             vm_tf->tf_guest_pcoreid);
374         printf("Flags  0x%08x\n",             vm_tf->tf_flags);
375         printf("Inject 0x%08x\n",             vm_tf->tf_trap_inject);
376         printf("ExitRs 0x%08x\n",             vm_tf->tf_exit_reason);
377         printf("ExitQl 0x%08x\n",             vm_tf->tf_exit_qual);
378         printf("Intr1  0x%016lx\n",           vm_tf->tf_intrinfo1);
379         printf("Intr2  0x%016lx\n",           vm_tf->tf_intrinfo2);
380         printf("GIntr  0x----%04x\n",         vm_tf->tf_guest_intr_status);
381         printf("GVA    0x%016lx\n",           vm_tf->tf_guest_va);
382         printf("GPA    0x%016lx\n",           vm_tf->tf_guest_pa);
383 }
384
385 void print_user_context(struct user_context *ctx)
386 {
387         switch (ctx->type) {
388         case ROS_HW_CTX:
389                 print_hw_tf(&ctx->tf.hw_tf);
390                 break;
391         case ROS_SW_CTX:
392                 print_sw_tf(&ctx->tf.sw_tf);
393                 break;
394         case ROS_VM_CTX:
395                 print_vm_tf(&ctx->tf.vm_tf);
396                 break;
397         default:
398                 printf("Unknown context type %d\n", ctx->type);
399         }
400 }
401
402 /* The second-lowest level function jumped to by the kernel on every vcore
403  * entry.  We get called from __kernel_vcore_entry.
404  *
405  * We should consider making it mandatory to set the tls_desc in the kernel. We
406  * wouldn't even need to pass the vcore id to user space at all if we did this.
407  * It would already be set in the preinstalled TLS as __vcore_id. */
408 void __attribute__((noreturn)) __kvc_entry_c(void)
409 {
410         /* The kernel sets the TLS desc for us, based on whatever is in VCPD.
411          *
412          * x86 32-bit TLS is pretty jacked up, so the kernel doesn't set the TLS
413          * desc for us.  it's a little more expensive to do it here, esp for
414          * amd64.  Can remove this when/if we overhaul 32 bit TLS. */
415         int id = __vcore_id_on_entry;
416
417         #ifndef __x86_64__
418         set_tls_desc(vcpd_of(id)->vcore_tls_desc);
419         #endif
420         /* Every time the vcore comes up, it must set that it is in vcore context.
421          * uthreads may share the same TLS as their vcore (when uthreads do not have
422          * their own TLS), and if a uthread was preempted, __vcore_context == FALSE,
423          * and that will continue to be true the next time the vcore pops up. */
424         __vcore_context = TRUE;
425         vcore_entry();
426         fprintf(stderr, "vcore_entry() should never return!\n");
427         abort();
428         __builtin_unreachable();
429 }