6155d8d21953fa63f8fc780d43203aa82dd4fc1c
[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 /* Here's how the HW popping works:  It sets up the future stack pointer to
16  * have extra stuff after it, and then it pops the registers, then pops the new
17  * context's stack pointer.  Then it uses the extra stuff (the new PC is on the
18  * stack, the location of notif_disabled, and a clobbered work register) to
19  * enable notifs, make sure notif IPIs weren't pending, restore the work reg,
20  * and then "ret".
21  *
22  * This is what the target uthread's stack will look like (growing down):
23  *
24  * Target RSP -> |   u_thread's old stuff   | the future %rsp, tf->tf_rsp
25  *               |   new rip                | 0x08 below %rsp (one slot is 0x08)
26  *               |   rflags space           | 0x10 below
27  *               |   rdi save space         | 0x18 below
28  *               |   *sysc ptr to syscall   | 0x20 below
29  *               |   notif_pending_loc      | 0x28 below
30  *               |   notif_disabled_loc     | 0x30 below
31  *
32  * The important thing is that it can handle a notification after it enables
33  * notifications, and when it gets resumed it can ultimately run the new
34  * context.  Enough state is saved in the running context and stack to continue
35  * running.
36  *
37  * Related to that is whether or not our stack pointer is sufficiently far down
38  * so that restarting *this* code won't clobber shit we need later.  The way we
39  * do this is that we do any "stack jumping" before we enable interrupts/notifs.
40  * These jumps are when we directly modify rsp, specifically in the down
41  * direction (subtracts).  Adds would be okay.
42  *
43  * Another 64-bit concern is the red-zone.  The AMD64 ABI allows the use of
44  * space below the stack pointer by regular programs.  If we allowed this, we
45  * would clobber that space when we do our TF restarts, much like with OSs and
46  * IRQ handlers.  Thus we have the cross compiler automatically disabling the
47  * redzone (-mno-red-zone is a built-in option).
48  *
49  * When compared to the 32 bit code, notice we use rdi, instead of eax, for our
50  * work.  This is because rdi is the arg0 of a syscall.  Using it saves us some
51  * extra moves, since we need to pop the *sysc before saving any other
52  * registers. */
53
54 /* Helper for writing the info we need later to the u_tf's stack.  Also, note
55  * this goes backwards, since memory reads up the stack. */
56 struct restart_helper {
57         void                                            *notif_disab_loc;
58         void                                            *notif_pend_loc;
59         struct syscall                          *sysc;
60         uint64_t                                        rdi_save;
61         uint64_t                                        rflags;
62         uint64_t                                        rip;
63 };
64
65 /* Static syscall, used for self-notifying.  We never wait on it, and we
66  * actually might submit it multiple times in parallel on different cores!
67  * While this may seem dangerous, the kernel needs to be able to handle this
68  * scenario.  It's also important that we never wait on this, since for all but
69  * the first call, the DONE flag will be set.  (Set once, then never reset) */
70 extern struct syscall vc_entry; /* in x86/vcore.c */
71
72 static inline void pop_hw_tf(struct hw_trapframe *tf, uint32_t vcoreid)
73 {
74         struct restart_helper *rst;
75         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
76         /* The stuff we need to write will be below the current stack of the utf */
77         rst = (struct restart_helper*)((void*)tf->tf_rsp -
78                                        sizeof(struct restart_helper));
79         /* Fill in the info we'll need later */
80         rst->notif_disab_loc = &vcpd->notif_disabled;
81         rst->notif_pend_loc = &vcpd->notif_pending;
82         rst->sysc = &vc_entry;
83         rst->rdi_save = 0;                      /* avoid bugs */
84         rst->rflags = tf->tf_rflags;
85         rst->rip = tf->tf_rip;
86
87         asm volatile ("movq %0, %%rsp;       " /* jump rsp to the utf */
88                       "popq %%rax;           " /* restore registers */
89                       "popq %%rbx;           "
90                       "popq %%rcx;           "
91                       "popq %%rdx;           "
92                       "popq %%rbp;           "
93                       "popq %%rsi;           "
94                       "popq %%rdi;           "
95                       "popq %%r8;            "
96                       "popq %%r9;            "
97                       "popq %%r10;           "
98                       "popq %%r11;           "
99                       "popq %%r12;           "
100                       "popq %%r13;           "
101                       "popq %%r14;           "
102                       "popq %%r15;           "
103                       "addq $0x28, %%rsp;    " /* move to the rsp slot in the tf */
104                       "popq %%rsp;           " /* change to the utf's %rsp */
105                       "subq $0x10, %%rsp;    " /* move rsp to below rdi's slot */
106                       "pushq %%rdi;          " /* save rdi, will clobber soon */
107                       "subq $0x18, %%rsp;    " /* move to notif_dis_loc slot */
108                       "popq %%rdi;           " /* load notif_disabled addr */
109                       "movb $0x00, (%%rdi);  " /* enable notifications */
110                                   /* Need a wrmb() here so the write of enable_notif can't pass
111                                    * the read of notif_pending (racing with a potential
112                                    * cross-core call with proc_notify()). */
113                                   "lock addq $0, (%%rdi);" /* LOCK is a CPU mb() */
114                                   /* From here down, we can get interrupted and restarted */
115                       "popq %%rdi;           " /* get notif_pending status loc */
116                       "testb $0x01, (%%rdi); " /* test if a notif is pending */
117                       "jz 1f;                " /* if not pending, skip syscall */
118                                   /* Actual syscall.  Note we don't wait on the async call */
119                       "popq %%rdi;           " /* &sysc, trap arg0 */
120                       "pushq %%rsi;          " /* save rax, will be trap arg1 */
121                       "pushq %%rax;          " /* save rax, will be trap ret */
122                       "movq $0x1, %%rsi;     " /* sending one async syscall: arg1 */
123                       "int %1;               " /* fire the syscall */
124                       "popq %%rax;           " /* restore regs after syscall */
125                       "popq %%rsi;           "
126                       "jmp 2f;               " /* skip 1:, already popped */
127                                   "1: addq $0x08, %%rsp; " /* discard &sysc (on non-sc path) */
128                       "2: popq %%rdi;        " /* restore tf's %rdi (both paths) */
129                                   "popfq;                " /* restore utf's rflags */
130                       "ret;                  " /* return to the new PC */
131                       :
132                       : "g"(&tf->tf_rax), "i"(T_SYSCALL)
133                       : "memory");
134 }
135
136 static inline void pop_sw_tf(struct sw_trapframe *sw_tf, uint32_t vcoreid)
137 {
138         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
139         /* Restore callee-saved FPU state.  We need to clear exceptions before
140          * reloading the FP CW, in case the new CW unmasks any.  We also need to
141          * reset the tag word to clear out the stack.
142          *
143          * The main issue here is that while our context was saved in an
144          * ABI-complaint manner, we may be starting up on a somewhat random FPU
145          * state.  Having gibberish in registers isn't a big deal, but some of the
146          * FP environment settings could cause trouble.  If fnclex; emms isn't
147          * enough, we could also save/restore the entire FP env with fldenv, or do
148          * an fninit before fldcw. */
149         asm volatile ("ldmxcsr %0" : : "m"(sw_tf->tf_mxcsr));
150         asm volatile ("fnclex; emms; fldcw %0" : : "m"(sw_tf->tf_fpucw));
151         /* Basic plan: restore all regs, off rcx as the sw_tf.  Switch to the new
152          * stack, save the PC so we can jump to it later.  Use clobberably
153          * registers for the locations of sysc, notif_dis, and notif_pend. Once on
154          * the new stack, we enable notifs, check if we missed one, and if so, self
155          * notify.  Note the syscall clobbers rax. */
156         asm volatile ("movq 0x00(%0), %%rbx; " /* restore regs */
157                       "movq 0x08(%0), %%rbp; "
158                       "movq 0x10(%0), %%r12; "
159                       "movq 0x18(%0), %%r13; "
160                       "movq 0x20(%0), %%r14; "
161                       "movq 0x28(%0), %%r15; "
162                       "movq 0x30(%0), %%r8;  " /* save rip in r8 */
163                       "movq 0x38(%0), %%rsp; " /* jump to future stack */
164                       "movb $0x00, (%2);     " /* enable notifications */
165                       /* Need a wrmb() here so the write of enable_notif can't pass
166                        * the read of notif_pending (racing with a potential
167                        * cross-core call with proc_notify()). */
168                       "lock addq $0, (%2);   " /* LOCK is a CPU mb() */
169                       /* From here down, we can get interrupted and restarted */
170                       "testb $0x01, (%3);    " /* test if a notif is pending */
171                       "jz 1f;                " /* if not pending, skip syscall */
172                       /* Actual syscall.  Note we don't wait on the async call.
173                        * &vc_entry is already in rdi (trap arg0). */
174                       "movq $0x1, %%rsi;     " /* sending one async syscall: arg1 */
175                       "int %4;               " /* fire the syscall */
176                       "1: jmp *%%r8;         " /* ret saved earlier */
177                       :
178                       : "c"(&sw_tf->tf_rbx),
179                         "D"(&vc_entry),
180                         "S"(&vcpd->notif_disabled),
181                         "d"(&vcpd->notif_pending),
182                         "i"(T_SYSCALL)
183                       : "memory");
184 }
185
186 /* Pops a user context, reanabling notifications at the same time.  A Userspace
187  * scheduler can call this when transitioning off the transition stack.
188  *
189  * At some point in vcore context before calling this, you need to clear
190  * notif_pending (do this by calling handle_events()).  As a potential
191  * optimization, consider clearing the notif_pending flag / handle_events again
192  * (right before popping), right before calling this.  If notif_pending is not
193  * clear, this will self_notify this core, since it should be because we missed
194  * a notification message while notifs were disabled. */
195 static inline void pop_user_ctx(struct user_context *ctx, uint32_t vcoreid)
196 {
197         if (ctx->type == ROS_HW_CTX)
198                 pop_hw_tf(&ctx->tf.hw_tf, vcoreid);
199         else
200                 pop_sw_tf(&ctx->tf.sw_tf, vcoreid);
201 }
202
203 /* Like the regular pop_user_ctx, but this one doesn't check or clear
204  * notif_pending.  The only case where we use this is when an IRQ/notif
205  * interrupts a uthread that is in the process of disabling notifs. */
206 static inline void pop_user_ctx_raw(struct user_context *ctx, uint32_t vcoreid)
207 {
208         struct hw_trapframe *tf = &ctx->tf.hw_tf;
209         assert(ctx->type == ROS_HW_CTX);
210         struct restart_helper *rst;
211         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
212         /* The stuff we need to write will be below the current stack of the utf */
213         rst = (struct restart_helper*)((void*)tf->tf_rsp -
214                                        sizeof(struct restart_helper));
215         /* Fill in the info we'll need later */
216         rst->notif_disab_loc = &vcpd->notif_disabled;
217         rst->rdi_save = 0;                      /* avoid bugs */
218         rst->rflags = tf->tf_rflags;
219         rst->rip = tf->tf_rip;
220
221         asm volatile ("movq %0, %%rsp;       " /* jump esp to the utf */
222                       "popq %%rax;           " /* restore registers */
223                       "popq %%rbx;           "
224                       "popq %%rcx;           "
225                       "popq %%rdx;           "
226                       "popq %%rbp;           "
227                       "popq %%rsi;           "
228                       "popq %%rdi;           "
229                       "popq %%r8;            "
230                       "popq %%r9;            "
231                       "popq %%r10;           "
232                       "popq %%r11;           "
233                       "popq %%r12;           "
234                       "popq %%r13;           "
235                       "popq %%r14;           "
236                       "popq %%r15;           "
237                       "addq $0x28, %%rsp;    " /* move to the rsp slot in the tf */
238                       "popq %%rsp;           " /* change to the utf's %rsp */
239                       "subq $0x10, %%rsp;    " /* move rsp to below rdi's slot */
240                       "pushq %%rdi;          " /* save rdi, will clobber soon */
241                       "subq $0x18, %%rsp;    " /* move to notif_dis_loc slot */
242                       "popq %%rdi;           " /* load notif_disabled addr */
243                       "movb $0x00, (%%rdi);  " /* enable notifications */
244                                   /* Here's where we differ from the regular pop_user_ctx().
245                                    * We need to adjust rsp and whatnot, but don't do test,
246                                    * clear notif_pending, or call a syscall. */
247                                   /* From here down, we can get interrupted and restarted */
248                       "addq $0x10, %%rsp;    " /* move to rdi save slot */
249                       "popq %%rdi;           " /* restore tf's %rdi */
250                                   "popfq;                " /* restore utf's rflags */
251                       "ret;                  " /* return to the new PC */
252                       :
253                       : "g"(&tf->tf_rax)
254                       : "memory");
255 }
256
257 /* Save's a SW context, setting the PC to the end of this function.  We only
258  * save callee-saved registers (of the sysv abi).  The compiler knows to save
259  * the others via the input/clobber lists.
260  *
261  * Callers of this function need to have at least one
262  * 'calling-convention-compliant' function call between this and any floating
263  * point, so that the compiler saves any caller-saved FP before getting to
264  * here.
265  *
266  * To some extent, TLS is 'callee-saved', in that no one ever expects it to
267  * change.  We handle uthread TLS changes separately, since we often change to
268  * them early to set some variables.  Arguably we should do this different. */
269 static inline void save_user_ctx(struct user_context *ctx)
270 {
271         struct sw_trapframe *sw_tf = &ctx->tf.sw_tf;
272         long dummy;
273         ctx->type = ROS_SW_CTX;
274         asm volatile ("stmxcsr %0" : "=m"(sw_tf->tf_mxcsr));
275         asm volatile ("fnstcw %0" : "=m"(sw_tf->tf_fpucw));
276         /* Pretty simple: save all the regs, IAW the sys-v ABI */
277         asm volatile("mov %%rsp, 0x48(%0);   " /* save rsp in its slot*/
278                      "leaq 1f(%%rip), %%rax; " /* get future rip */
279                      "mov %%rax, 0x40(%0);   " /* save rip in its slot*/
280                      "mov %%r15, 0x38(%0);   "
281                      "mov %%r14, 0x30(%0);   "
282                      "mov %%r13, 0x28(%0);   "
283                      "mov %%r12, 0x20(%0);   "
284                      "mov %%rbp, 0x18(%0);   "
285                      "mov %%rbx, 0x10(%0);   "
286                      "1:                     " /* where this tf will restart */
287                      : "=D"(dummy) /* force clobber for rdi */
288                                  : "D"(sw_tf)
289                      : "rax", "rcx", "rdx", "rsi", "r8", "r9", "r10", "r11",
290                        "memory", "cc");
291 } __attribute__((always_inline, returns_twice))
292
293 /* The old version, kept around for testing */
294 /* Hasn't been used yet for 64 bit.  If you use this, it's worth checking to
295  * make sure rax isn't selected for 0, 1, or 2. (and we probably don't need to
296  * save rax in the beginning) */
297 static inline void save_user_ctx_hw(struct user_context *ctx)
298 {
299         struct hw_trapframe *tf = &ctx->tf.hw_tf;
300         ctx->type = ROS_HW_CTX;
301         memset(tf, 0, sizeof(struct hw_trapframe)); /* sanity */
302         /* set CS and make sure eflags is okay */
303         tf->tf_cs = GD_UT | 3;
304         tf->tf_rflags = 0x200; /* interrupts enabled.  bare minimum rflags. */
305         /* Save the regs and the future rsp. */
306         asm volatile("movq %%rsp, (%0);      " /* save rsp in it's slot*/
307                      "pushq %%rax;           " /* temp save rax */
308                      "leaq 1f, %%rax;        " /* get future rip */
309                      "movq %%rax, (%1);      " /* store future rip */
310                      "popq %%rax;            " /* restore rax */
311                      "movq %2, %%rsp;        " /* move to the rax slot of the tf */
312                      "addl $0x78,%%esp;      " /* move to just past r15 */
313                      "pushq %%r15;           " /* save regs */
314                      "pushq %%r14;           "
315                      "pushq %%r13;           "
316                      "pushq %%r12;           "
317                      "pushq %%r11;           "
318                      "pushq %%r10;           "
319                      "pushq %%r9;            "
320                      "pushq %%r8;            "
321                      "pushq %%rdi;           "
322                      "pushq %%rsi;           "
323                      "pushq %%rbp;           "
324                      "pushq %%rdx;           "
325                      "pushq %%rcx;           "
326                      "pushq %%rbx;           "
327                      "pushq %%rax;           "
328                      "addq $0xa0, %%rsp;     " /* move to rsp slot */
329                      "popq %%rsp;            " /* restore saved/original rsp */
330                      "1:                     " /* where this tf will restart */
331                      : 
332                      : "g"(&tf->tf_rsp), "g"(&tf->tf_rip), "g"(tf->tf_rax)
333                      : "rax", "memory", "cc");
334 } __attribute__((always_inline, returns_twice))
335
336 static inline void init_user_ctx(struct user_context *ctx, uintptr_t entry_pt,
337                                  uintptr_t stack_top)
338 {
339         struct sw_trapframe *sw_tf = &ctx->tf.sw_tf;
340         ctx->type = ROS_SW_CTX;
341         /* Stack pointers in a fresh stackframe need to be such that adding or
342          * subtracting 8 will result in 16 byte alignment (AMD64 ABI).  The reason
343          * is so that input arguments (on the stack) are 16 byte aligned.  The
344          * extra 8 bytes is the retaddr, pushed on the stack.  Compilers know they
345          * can subtract 8 to get 16 byte alignment for instructions like movaps. */
346         sw_tf->tf_rsp = ROUNDDOWN(stack_top, 16) - 8;
347         sw_tf->tf_rip = entry_pt;
348         sw_tf->tf_rbp = 0;      /* for potential backtraces */
349         /* No need to bother with setting the other GP registers; the called
350          * function won't care about their contents. */
351         sw_tf->tf_mxcsr = 0x00001f80;   /* x86 default mxcsr */
352         sw_tf->tf_fpucw = 0x037f;               /* x86 default FP CW */
353 }
354
355 // this is how we get our thread id on entry.
356 #define __vcore_id_on_entry \
357 ({ \
358         register int temp asm ("rbx"); \
359         temp; \
360 })
361
362 /* For debugging. */
363 #include <stdio.h>
364 static void print_hw_tf(struct hw_trapframe *hw_tf)
365 {
366         printf("[user] HW TRAP frame 0x%016x\n", hw_tf);
367         printf("  rax  0x%016lx\n",           hw_tf->tf_rax);
368         printf("  rbx  0x%016lx\n",           hw_tf->tf_rbx);
369         printf("  rcx  0x%016lx\n",           hw_tf->tf_rcx);
370         printf("  rdx  0x%016lx\n",           hw_tf->tf_rdx);
371         printf("  rbp  0x%016lx\n",           hw_tf->tf_rbp);
372         printf("  rsi  0x%016lx\n",           hw_tf->tf_rsi);
373         printf("  rdi  0x%016lx\n",           hw_tf->tf_rdi);
374         printf("  r8   0x%016lx\n",           hw_tf->tf_r8);
375         printf("  r9   0x%016lx\n",           hw_tf->tf_r9);
376         printf("  r10  0x%016lx\n",           hw_tf->tf_r10);
377         printf("  r11  0x%016lx\n",           hw_tf->tf_r11);
378         printf("  r12  0x%016lx\n",           hw_tf->tf_r12);
379         printf("  r13  0x%016lx\n",           hw_tf->tf_r13);
380         printf("  r14  0x%016lx\n",           hw_tf->tf_r14);
381         printf("  r15  0x%016lx\n",           hw_tf->tf_r15);
382         printf("  trap 0x%08x\n",             hw_tf->tf_trapno);
383         printf("  gsbs 0x%016lx\n",           hw_tf->tf_gsbase);
384         printf("  fsbs 0x%016lx\n",           hw_tf->tf_fsbase);
385         printf("  err  0x--------%08x\n",     hw_tf->tf_err);
386         printf("  rip  0x%016lx\n",           hw_tf->tf_rip);
387         printf("  cs   0x------------%04x\n", hw_tf->tf_cs);
388         printf("  flag 0x%016lx\n",           hw_tf->tf_rflags);
389         printf("  rsp  0x%016lx\n",           hw_tf->tf_rsp);
390         printf("  ss   0x------------%04x\n", hw_tf->tf_ss);
391 }
392
393 static void print_sw_tf(struct sw_trapframe *sw_tf)
394 {
395         printf("[user] SW TRAP frame 0x%016p\n", sw_tf);
396         printf("  rbx  0x%016lx\n",           sw_tf->tf_rbx);
397         printf("  rbp  0x%016lx\n",           sw_tf->tf_rbp);
398         printf("  r12  0x%016lx\n",           sw_tf->tf_r12);
399         printf("  r13  0x%016lx\n",           sw_tf->tf_r13);
400         printf("  r14  0x%016lx\n",           sw_tf->tf_r14);
401         printf("  r15  0x%016lx\n",           sw_tf->tf_r15);
402         printf("  gsbs 0x%016lx\n",           sw_tf->tf_gsbase);
403         printf("  fsbs 0x%016lx\n",           sw_tf->tf_fsbase);
404         printf("  rip  0x%016lx\n",           sw_tf->tf_rip);
405         printf("  rsp  0x%016lx\n",           sw_tf->tf_rsp);
406         printf(" mxcsr 0x%08x\n",             sw_tf->tf_mxcsr);
407         printf(" fpucw 0x%04x\n",             sw_tf->tf_fpucw);
408 }
409
410 static void print_user_context(struct user_context *ctx)
411 {
412         if (ctx->type == ROS_HW_CTX)
413                 print_hw_tf(&ctx->tf.hw_tf);
414         else if (ctx->type == ROS_SW_CTX)
415                 print_sw_tf(&ctx->tf.sw_tf);
416         else
417                 printf("Unknown context type %d\n", ctx->type);
418 }
419
420 static bool has_refl_fault(struct user_context *ctx)
421 {
422         return ctx->tf.hw_tf.tf_padding3 == ROS_ARCH_REFL_ID;
423 }
424
425 static void clear_refl_fault(struct user_context *ctx)
426 {
427         ctx->tf.hw_tf.tf_padding3 = 0;
428 }
429
430 static unsigned int __arch_refl_get_nr(struct user_context *ctx)
431 {
432         return ctx->tf.hw_tf.tf_trapno;
433 }
434
435 static unsigned int __arch_refl_get_err(struct user_context *ctx)
436 {
437         return ctx->tf.hw_tf.tf_err;
438 }
439
440 static unsigned long __arch_refl_get_aux(struct user_context *ctx)
441 {
442         return ((unsigned long)ctx->tf.hw_tf.tf_padding5 << 32) |
443                ctx->tf.hw_tf.tf_padding4;
444 }
445
446 #endif /* PARLIB_ARCH_VCORE64_H */