Fixes bug in pop_ros_tf
[akaros.git] / user / parlib / include / i686 / vcore.h
1 #ifndef PARLIB_ARCH_VCORE_H
2 #define PARLIB_ARCH_VCORE_H
3
4 #include <ros/common.h>
5 #include <ros/arch/trapframe.h>
6 #include <ros/procdata.h>
7 #include <ros/syscall.h>
8 #include <ros/arch/mmu.h>
9
10 extern __thread int __vcoreid;
11
12 /* Pops an ROS kernel-provided TF, reanabling notifications at the same time.
13  * A Userspace scheduler can call this when transitioning off the transition
14  * stack.
15  *
16  * Make sure you clear the notif_pending flag, and then check the queue before
17  * calling this.  If notif_pending is not clear, this will self_notify this
18  * core, since it should be because we missed a notification message while
19  * notifs were disabled. 
20  *
21  * Basically, it sets up the future stack pointer to have extra stuff after it,
22  * and then it pops the registers, then pops the new context's stack
23  * pointer.  Then it uses the extra stuff (the new PC is on the stack, the
24  * location of notif_enabled, and a clobbered work register) to enable notifs,
25  * make sure notif IPIs weren't pending, restore the work reg, and then "ret".
26  *
27  * This is what the target notif_tf's stack will look like (growing down):
28  *
29  * Target ESP -> |   u_thread's old stuff   | the future %esp, tf->tf_esp
30  *               |   new eip                | 0x04 below %esp (one slot is 0x04)
31  *               |   eflags space           | 0x08 below
32  *               |   eax save space         | 0x0c below
33  *               |   actual syscall         | 0x10 below (0x30 space)
34  *               |   *sysc ptr to syscall   | 0x40 below (0x10 + 0x30)
35  *               |   notif_pending_loc      | 0x44 below (0x10 + 0x30)
36  *               |   notif_enabled_loc      | 0x48 below (0x10 + 0x30)
37  *
38  * The important thing is that it can handle a notification after it enables
39  * notifications, and when it gets resumed it can ultimately run the new
40  * context.  Enough state is saved in the running context and stack to continue
41  * running.
42  *
43  * Related to that is whether or not our stack pointer is sufficiently far down
44  * so that restarting *this* code won't clobber shit we need later.  The way we
45  * do this is that we do any "stack jumping" after we enable interrupts/notifs.
46  * These jumps are when we directly modify esp, specifically in the down
47  * direction (subtracts).  Adds would be okay.
48  *
49  * Another related concern is the storage for sysc.  It used to be on the
50  * vcore's stack, but if an interrupt comes in before we use it, we trash the
51  * vcore's stack (and thus the storage for sysc!).  Instead, we put it on the
52  * stack of the user tf.  Moral: don't touch a vcore's stack with notifs
53  * enabled. */
54
55 /* Helper for writing the info we need later to the u_tf's stack.  Note, this
56  * could get fucked if the struct syscall isn't a multiple of 4-bytes.  Also,
57  * note this goes backwards, since memory reads up the stack. */
58 struct restart_helper {
59         uint32_t                                        notif_enab_loc;
60         uint32_t                                        notif_pend_loc;
61         struct syscall                          *sysc;
62         struct syscall                          local_sysc;
63         uint32_t                                        eax_save;
64         uint32_t                                        eflags;
65         uint32_t                                        eip;
66 };
67
68 static inline void pop_ros_tf(struct user_trapframe *tf, uint32_t vcoreid)
69 {
70         struct restart_helper *rst;
71         struct preempt_data *vcpd = &__procdata.vcore_preempt_data[vcoreid];
72         if (!tf->tf_cs) { /* sysenter TF.  esp and eip are in other regs. */
73                 tf->tf_esp = tf->tf_regs.reg_ebp;
74                 tf->tf_eip = tf->tf_regs.reg_edx;
75         }
76         /* The stuff we need to write will be below the current stack of the utf */
77         rst = (struct restart_helper*)((void*)tf->tf_esp -
78                                        sizeof(struct restart_helper));
79         /* Fill in the info we'll need later */
80         rst->notif_enab_loc = (uint32_t)&vcpd->notif_enabled;
81         rst->notif_pend_loc = (uint32_t)&vcpd->notif_pending;
82         rst->sysc = &rst->local_sysc;   /* point to the local one */
83         memset(rst->sysc, 0, sizeof(struct syscall));
84         /* Need to prep the async sysc in case we need to notify ourselves */
85         rst->sysc->num = SYS_self_notify;
86         rst->sysc->arg0 = vcoreid;      /* arg 1 & 2 already = 0 (null notif, no u_ne)*/
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_enabaled addr */
101                       "movb $0x01,(%%eax);   " /* enable notifications */
102                                   /* From here down, we can get interrupted and restarted */
103                       "popl %%eax;           " /* get notif_pending status */
104                       "testb $0x01,(%%eax);  " /* test if a notif is pending */
105                       "jz 1f;                " /* if not pending, skip syscall */
106                       "movb $0x00,(%%eax);   " /* clear pending */
107                                   /* Actual syscall.  Note we don't wait on the async call */
108                       "popl %%eax;           " /* &sysc, trap arg0 */
109                       "pushl %%edx;          " /* save edx, will be trap arg1 */
110                       "movl $0x1,%%edx;      " /* sending one async syscall: arg1 */
111                       "int %1;               " /* fire the syscall */
112                       "popl %%edx;           " /* restore regs after syscall */
113                       "jmp 2f;               " /* skip 1:, already popped */
114                                   "1: popl %%eax;        " /* discard &sysc (on non-sc path) */
115                       "2: addl %2,%%esp;     " /* jump over the sysc (both paths) */
116                       "popl %%eax;           " /* restore tf's %eax */
117                                   "popfl;                " /* restore utf's eflags */
118                       "ret;                  " /* return to the new PC */
119                       :
120                       : "g"(tf), "i"(T_SYSCALL), "i"(sizeof(struct syscall))
121                       : "memory");
122 }
123
124 /* Save the current context/registers into the given tf, setting the pc of the
125  * tf to the end of this function.  You only need to save that which you later
126  * restore with pop_ros_tf(). */
127 static inline void save_ros_tf(struct user_trapframe *tf)
128 {
129         memset(tf, 0, sizeof(struct user_trapframe)); /* sanity */
130         /* set CS and make sure eflags is okay */
131         tf->tf_cs = GD_UT | 3;
132         tf->tf_eflags = 0x00000200; /* interrupts enabled.  bare minimum eflags. */
133         /* Save the regs and the future esp. */
134         asm volatile("movl %%esp,(%0);       " /* save esp in it's slot*/
135                      "pushl %%eax;           " /* temp save eax */
136                      "leal 1f,%%eax;         " /* get future eip */
137                      "movl %%eax,(%1);       " /* store future eip */
138                      "popl %%eax;            " /* restore eax */
139                      "movl %2,%%esp;         " /* move to the beginning of the tf */
140                      "addl $0x20,%%esp;      " /* move to after the push_regs */
141                      "pushal;                " /* save regs */
142                      "addl $0x44,%%esp;      " /* move to esp slot */
143                      "popl %%esp;            " /* restore esp */
144                      "1:                     " /* where this tf will restart */
145                      : 
146                      : "g"(&tf->tf_esp), "g"(&tf->tf_eip), "g"(tf)
147                      : "eax", "memory", "cc");
148 }
149
150 /* This assumes a user_tf looks like a regular kernel trapframe */
151 static __inline void
152 init_user_tf(struct user_trapframe *u_tf, uint32_t entry_pt, uint32_t stack_top)
153 {
154         memset(u_tf, 0, sizeof(struct user_trapframe));
155         u_tf->tf_eip = entry_pt;
156         u_tf->tf_cs = GD_UT | 3;
157         u_tf->tf_esp = stack_top;
158 }
159
160 /* Reading from the LDT.  Could also use %gs, but that would require including
161  * half of libc's TLS header.  Sparc will probably ignore the vcoreid, so don't
162  * rely on it too much.  The intent of it is vcoreid is the caller's vcoreid,
163  * and that vcoreid might be in the TLS of the caller (it will be for transition
164  * stacks) and we could avoid a trap on x86 to sys_getvcoreid(). */
165 static inline void *get_tls_desc(uint32_t vcoreid)
166 {
167         return (void*)(__procdata.ldt[vcoreid].sd_base_31_24 << 24 |
168                        __procdata.ldt[vcoreid].sd_base_23_16 << 16 |
169                        __procdata.ldt[vcoreid].sd_base_15_0);
170 }
171
172 /* passing in the vcoreid, since it'll be in TLS of the caller */
173 static inline void set_tls_desc(void *tls_desc, uint32_t vcoreid)
174 {
175         /* Keep this technique in sync with sysdeps/ros/i386/tls.h */
176         segdesc_t tmp = SEG(STA_W, (uint32_t)tls_desc, 0xffffffff, 3);
177         __procdata.ldt[vcoreid] = tmp;
178
179         /* GS is still the same (should be!), but it needs to be reloaded to force a
180          * re-read of the LDT. */
181         uint32_t gs = (vcoreid << 3) | 0x07;
182         asm volatile("movl %0,%%gs" : : "r" (gs) : "memory");
183
184         __vcoreid = vcoreid;
185 }
186
187 // this is how we get our thread id on entry.
188 #define __vcore_id_on_entry \
189 ({ \
190         register int temp asm ("eax"); \
191         temp; \
192 })
193
194 /* For debugging. */
195 #include <rstdio.h>
196 static __inline void print_trapframe(struct user_trapframe *tf)
197 {
198         printf("[user] TRAP frame\n");
199         printf("  edi  0x%08x\n", tf->tf_regs.reg_edi);
200         printf("  esi  0x%08x\n", tf->tf_regs.reg_esi);
201         printf("  ebp  0x%08x\n", tf->tf_regs.reg_ebp);
202         printf("  oesp 0x%08x\n", tf->tf_regs.reg_oesp);
203         printf("  ebx  0x%08x\n", tf->tf_regs.reg_ebx);
204         printf("  edx  0x%08x\n", tf->tf_regs.reg_edx);
205         printf("  ecx  0x%08x\n", tf->tf_regs.reg_ecx);
206         printf("  eax  0x%08x\n", tf->tf_regs.reg_eax);
207         printf("  gs   0x----%04x\n", tf->tf_gs);
208         printf("  fs   0x----%04x\n", tf->tf_fs);
209         printf("  es   0x----%04x\n", tf->tf_es);
210         printf("  ds   0x----%04x\n", tf->tf_ds);
211         printf("  trap 0x%08x\n", tf->tf_trapno);
212         printf("  err  0x%08x\n", tf->tf_err);
213         printf("  eip  0x%08x\n", tf->tf_eip);
214         printf("  cs   0x----%04x\n", tf->tf_cs);
215         printf("  flag 0x%08x\n", tf->tf_eflags);
216         printf("  esp  0x%08x\n", tf->tf_esp);
217         printf("  ss   0x----%04x\n", tf->tf_ss);
218 }
219
220 #endif /* PARLIB_ARCH_VCORE_H */