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