55236e9ced21e7d3b4e024ef0eaa6d2d482e78c3
[akaros.git] / user / parlib / uthread.c
1 #include <ros/arch/membar.h>
2 #include <arch/atomic.h>
3 #include <parlib.h>
4 #include <vcore.h>
5 #include <uthread.h>
6 #include <event.h>
7 #include <stdlib.h>
8
9 /* Which operations we'll call for the 2LS.  Will change a bit with Lithe.  For
10  * now, there are no defaults.  2LSs can override sched_ops. */
11 struct schedule_ops default_2ls_ops = {0};
12 struct schedule_ops *sched_ops __attribute__((weak)) = &default_2ls_ops;
13
14 __thread struct uthread *current_uthread = 0;
15 __thread bool __uth_disable_depth = 0;
16 /* ev_q for all preempt messages (handled here to keep 2LSs from worrying
17  * extensively about the details.  Will call out when necessary. */
18 struct event_queue *preempt_ev_q;
19
20 /* Helpers: */
21 #define UTH_TLSDESC_NOTLS (void*)(-1)
22 static inline bool __uthread_has_tls(struct uthread *uthread);
23 static int __uthread_allocate_tls(struct uthread *uthread);
24 static int __uthread_reinit_tls(struct uthread *uthread);
25 static void __uthread_free_tls(struct uthread *uthread);
26 static void __run_current_uthread_raw(void);
27
28 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type,
29                               void *data);
30 static void handle_vc_indir(struct event_msg *ev_msg, unsigned int ev_type,
31                             void *data);
32
33 /* Block the calling uthread on sysc until it makes progress or is done */
34 static void __ros_mcp_syscall_blockon(struct syscall *sysc);
35
36 /* Helper, make the uthread code manage thread0.  This sets up uthread such
37  * that the calling code and its TLS are tracked by the uthread struct, and
38  * vcore0 thinks the uthread is running there.  Called only by slim_init (early
39  * _S code) and lib_init.
40  *
41  * Whether or not uthreads have TLS, thread0 has TLS, given to it by glibc.
42  * This TLS will get set whenever we use thread0, regardless of whether or not
43  * we use TLS for uthreads in general.  glibc cares about this TLS and will use
44  * it at exit.  We can't simply use that TLS for VC0 either, since we don't know
45  * where thread0 will be running when the program ends. */
46 static void uthread_manage_thread0(struct uthread *uthread)
47 {
48         assert(uthread);
49         /* Save a pointer to thread0's tls region (the glibc one) into its tcb */
50         uthread->tls_desc = get_tls_desc(0);
51         /* Save a pointer to the uthread in its own TLS */
52         current_uthread = uthread;
53         /* Thread is currently running (it is 'us') */
54         uthread->state = UT_RUNNING;
55         /* utf/as doesn't represent the state of the uthread (we are running) */
56         uthread->flags &= ~(UTHREAD_SAVED | UTHREAD_FPSAVED);
57         /* need to track thread0 for TLS deallocation */
58         uthread->flags |= UTHREAD_IS_THREAD0;
59         /* Change temporarily to vcore0s tls region so we can save the newly created
60          * tcb into its current_uthread variable and then restore it.  One minor
61          * issue is that vcore0's transition-TLS isn't TLS_INITed yet.  Until it is
62          * (right before vcore_entry(), don't try and take the address of any of
63          * its TLS vars. */
64         set_tls_desc(get_vcpd_tls_desc(0), 0);
65         /* We might have a basic uthread already installed (from slim_init), so
66          * free it before installing the new one. */
67         if (current_uthread)
68                 free(current_uthread);
69         current_uthread = uthread;
70         set_tls_desc(uthread->tls_desc, 0);
71         __vcoreid = 0;  /* setting the uthread's TLS var */
72         assert(!in_vcore_context());
73 }
74
75 /* The real 2LS calls this, passing in a uthread representing thread0.  When it
76  * returns, you're in _M mode, still running thread0, on vcore0 */
77 void uthread_lib_init(struct uthread *uthread)
78 {
79         init_once_racy(return);
80         vcore_init();
81         uthread_manage_thread0(uthread);
82         register_ev_handler(EV_EVENT, handle_ev_ev, 0);
83         /* Receive preemption events.  Note that this merely tells the kernel how to
84          * send the messages, and does not necessarily provide storage space for the
85          * messages.  What we're doing is saying that all PREEMPT and CHECK_MSGS
86          * events should be spammed to vcores that are running, preferring whatever
87          * the kernel thinks is appropriate.  And IPI them.
88          *
89          * It is critical that these are either SPAM_PUB or INDIR|FALLBACK, so that
90          * yielding vcores do not miss the preemption messages. */
91         register_ev_handler(EV_VCORE_PREEMPT, handle_vc_preempt, 0);
92         register_ev_handler(EV_CHECK_MSGS, handle_vc_indir, 0);
93         preempt_ev_q = get_event_q();   /* small ev_q, mostly a vehicle for flags */
94         preempt_ev_q->ev_flags = EVENT_IPI | EVENT_SPAM_PUBLIC | EVENT_VCORE_APPRO |
95                                                          EVENT_VCORE_MUST_RUN;
96         /* Tell the kernel to use the ev_q (it's settings) for the two types.  Note
97          * that we still have two separate handlers.  We just want the events
98          * delivered in the same way.  If we ever want to have a big_event_q with
99          * INDIRs, we could consider using separate ones. */
100         register_kevent_q(preempt_ev_q, EV_VCORE_PREEMPT);
101         register_kevent_q(preempt_ev_q, EV_CHECK_MSGS);
102         printd("[user] registered %08p (flags %08p) for preempt messages\n",
103                preempt_ev_q, preempt_ev_q->ev_flags);
104         /* Get ourselves into _M mode.  Could consider doing this elsewhere... */
105         vcore_change_to_m();
106 }
107
108 /* Helper: tells the kernel our SCP is capable of going into vcore context on
109  * vcore 0.  Pairs with k/s/process.c scp_is_vcctx_ready(). */
110 static void scp_vcctx_ready(void)
111 {
112         struct preempt_data *vcpd = vcpd_of(0);
113         long old_flags;
114         /* the CAS is a bit overkill; keeping it around in case people use this
115          * code in other situations. */
116         do {
117                 old_flags = atomic_read(&vcpd->flags);
118                 /* Spin if the kernel is mucking with the flags */
119                 while (old_flags & VC_K_LOCK)
120                         old_flags = atomic_read(&vcpd->flags);
121         } while (!atomic_cas(&vcpd->flags, old_flags,
122                              old_flags & ~VC_SCP_NOVCCTX));
123 }
124
125 /* For both of these, VC ctx uses the usual TLS errno/errstr.  Uthreads use
126  * their own storage.  Since we're called after manage_thread0, we should always
127  * have current_uthread if we are not in vc ctx. */
128 static int *__ros_errno_loc(void)
129 {
130         if (in_vcore_context())
131                 return __errno_location_tls();
132         else
133                 return &current_uthread->err_no;
134 }
135
136 static char *__ros_errstr_loc(void)
137 {
138         if (in_vcore_context())
139                 return __errstr_location_tls();
140         else
141                 return current_uthread->err_str;
142 }
143
144 /* Slim-init - sets up basic uthreading for when we are in _S mode and before
145  * we set up the 2LS.  Some apps may not have a 2LS and thus never do the full
146  * vcore/2LS/uthread init. */
147 void uthread_slim_init(void)
148 {
149         struct uthread *uthread;
150         int ret = posix_memalign((void**)&uthread, __alignof__(struct uthread),
151                                  sizeof(struct uthread));
152         assert(!ret);
153         memset(uthread, 0, sizeof(struct uthread));     /* aggressively 0 for bugs */
154         /* TODO: consider a vcore_init_vc0 call. */
155         vcore_init();
156         uthread_manage_thread0(uthread);
157         scp_vcctx_ready();
158         init_posix_signals();
159         /* change our blockon from glibc's internal one to the mcp one (which can
160          * handle SCPs too).  we must do this before switching to _M, or at least
161          * before blocking while an _M.  it's harmless (and probably saner) to do it
162          * earlier, so we do it as early as possible. */
163         ros_syscall_blockon = __ros_mcp_syscall_blockon;
164         /* Switch our errno/errstr functions to be uthread-aware.  See glibc's
165          * errno.c for more info. */
166         ros_errno_loc = __ros_errno_loc;
167         ros_errstr_loc = __ros_errstr_loc;
168 }
169
170 /* 2LSs shouldn't call uthread_vcore_entry directly */
171 void __attribute__((noreturn)) uthread_vcore_entry(void)
172 {
173         uint32_t vcoreid = vcore_id();
174         struct preempt_data *vcpd = vcpd_of(vcoreid);
175         /* Should always have notifications disabled when coming in here. */
176         assert(!notif_is_enabled(vcoreid));
177         assert(in_vcore_context());
178         /* If someone is stealing our uthread (from when we were preempted before),
179          * we can't touch our uthread.  But we might be the last vcore around, so
180          * we'll handle preemption events (spammed to our public mbox).
181          *
182          * It's important that we only check/handle one message per loop, otherwise
183          * we could get stuck in a ping-pong scenario with a recoverer (maybe). */
184         while (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
185                 /* Note we're handling INDIRs and other public messages while someone
186                  * is stealing our uthread.  Remember that those event handlers cannot
187                  * touch cur_uth, as it is "vcore business". */
188                 handle_one_mbox_msg(&vcpd->ev_mbox_public);
189                 cpu_relax();
190         }
191         /* If we have a current uthread that is DONT_MIGRATE, pop it real quick and
192          * let it disable notifs (like it wants to).  Other than dealing with
193          * preemption events (or other INDIRs), we shouldn't do anything in vc_ctx
194          * when we have a DONT_MIGRATE uthread. */
195         if (current_uthread && (current_uthread->flags & UTHREAD_DONT_MIGRATE))
196                 __run_current_uthread_raw();
197         /* Check and see if we wanted ourselves to handle a remote VCPD mbox.  Want
198          * to do this after we've handled STEALING and DONT_MIGRATE. */
199         try_handle_remote_mbox();
200         /* Otherwise, go about our usual vcore business (messages, etc). */
201         handle_events(vcoreid);
202         __check_preempt_pending(vcoreid);
203         assert(in_vcore_context());     /* double check, in case an event changed it */
204         /* Consider using the default_2ls_op for this, though it's a bit weird. */
205         if (sched_ops->sched_entry) {
206                 sched_ops->sched_entry();
207         } else if (current_uthread) {
208                 run_current_uthread();
209         }
210         /* 2LS sched_entry should never return */
211         /* Either the 2LS sched_entry returned, run_cur_uth() returned, or we
212          * didn't have a current_uthread.  If we didn't have a 2LS op, we should be
213          * in _S mode and always have a current_uthread. */
214         assert(0);
215 }
216
217 /* Does the uthread initialization of a uthread that the caller created.  Call
218  * this whenever you are "starting over" with a thread. */
219 void uthread_init(struct uthread *new_thread, struct uth_thread_attr *attr)
220 {
221         int ret;
222         assert(new_thread);
223         new_thread->state = UT_NOT_RUNNING;
224         /* They should have zero'd the uthread.  Let's check critical things: */
225         assert(!new_thread->flags && !new_thread->sysc);
226         /* the utf holds the GP context of the uthread (set by the 2LS earlier).
227          * There is no FP context to be restored yet.  We only save the FPU when we
228          * were interrupted off a core. */
229         new_thread->flags |= UTHREAD_SAVED;
230         if (attr && attr->want_tls) {
231                 /* Get a TLS.  If we already have one, reallocate/refresh it */
232                 if (new_thread->tls_desc)
233                         ret = __uthread_reinit_tls(new_thread);
234                 else
235                         ret = __uthread_allocate_tls(new_thread);
236                 assert(!ret);
237                 uthread_set_tls_var(new_thread, current_uthread, new_thread);
238         } else {
239                 new_thread->tls_desc = UTH_TLSDESC_NOTLS;
240         }
241 }
242
243 /* This is a wrapper for the sched_ops thread_runnable, for use by functions
244  * outside the main 2LS.  Do not put anything important in this, since the 2LSs
245  * internally call their sched op.  This is to improve batch wakeups (barriers,
246  * etc) */
247 void uthread_runnable(struct uthread *uthread)
248 {
249         assert(sched_ops->thread_runnable);
250         sched_ops->thread_runnable(uthread);
251 }
252
253 /* Informs the 2LS that its thread blocked, and it is not under the control of
254  * the 2LS.  This is for informational purposes, and some semantic meaning
255  * should be passed by flags (from uthread.h's UTH_EXT_BLK_xxx options).
256  * Eventually, whoever calls this will call uthread_runnable(), giving the
257  * thread back to the 2LS.
258  *
259  * If code outside the 2LS has blocked a thread (via uthread_yield) and ran its
260  * own callback/yield_func instead of some 2LS code, that callback needs to
261  * call this.
262  *
263  * AKA: obviously_a_uthread_has_blocked_in_lincoln_park() */
264 void uthread_has_blocked(struct uthread *uthread, int flags)
265 {
266         if (sched_ops->thread_has_blocked)
267                 sched_ops->thread_has_blocked(uthread, flags);
268 }
269
270 /* Need to have this as a separate, non-inlined function since we clobber the
271  * stack pointer before calling it, and don't want the compiler to play games
272  * with my hart. */
273 static void __attribute__((noinline, noreturn))
274 __uthread_yield(void)
275 {
276         struct uthread *uthread = current_uthread;
277         assert(in_vcore_context());
278         assert(!notif_is_enabled(vcore_id()));
279         /* Note: we no longer care if the thread is exiting, the 2LS will call
280          * uthread_destroy() */
281         uthread->flags &= ~UTHREAD_DONT_MIGRATE;
282         uthread->state = UT_NOT_RUNNING;
283         /* Do whatever the yielder wanted us to do */
284         assert(uthread->yield_func);
285         uthread->yield_func(uthread, uthread->yield_arg);
286         /* Make sure you do not touch uthread after that func call */
287         /* Leave the current vcore completely */
288         /* TODO: if the yield func can return a failure, we can abort the yield */
289         current_uthread = NULL;
290         /* Go back to the entry point, where we can handle notifications or
291          * reschedule someone. */
292         uthread_vcore_entry();
293 }
294
295 /* Calling thread yields for some reason.  Set 'save_state' if you want to ever
296  * run the thread again.  Once in vcore context in __uthread_yield, yield_func
297  * will get called with the uthread and yield_arg passed to it.  This way, you
298  * can do whatever you want when you get into vcore context, which can be
299  * thread_blockon_sysc, unlocking mutexes, joining, whatever.
300  *
301  * If you do *not* pass a 2LS sched op or other 2LS function as yield_func,
302  * then you must also call uthread_has_blocked(flags), which will let the 2LS
303  * know a thread blocked beyond its control (and why). */
304 void uthread_yield(bool save_state, void (*yield_func)(struct uthread*, void*),
305                    void *yield_arg)
306 {
307         struct uthread *uthread = current_uthread;
308         volatile bool yielding = TRUE; /* signal to short circuit when restarting */
309         assert(!in_vcore_context());
310         assert(uthread->state == UT_RUNNING);
311         /* Pass info to ourselves across the uth_yield -> __uth_yield transition. */
312         uthread->yield_func = yield_func;
313         uthread->yield_arg = yield_arg;
314         /* Don't migrate this thread to another vcore, since it depends on being on
315          * the same vcore throughout (once it disables notifs).  The race is that we
316          * read vcoreid, then get interrupted / migrated before disabling notifs. */
317         uthread->flags |= UTHREAD_DONT_MIGRATE;
318         cmb();  /* don't let DONT_MIGRATE write pass the vcoreid read */
319         uint32_t vcoreid = vcore_id();
320         printd("[U] Uthread %08p is yielding on vcore %d\n", uthread, vcoreid);
321         struct preempt_data *vcpd = vcpd_of(vcoreid);
322         /* once we do this, we might miss a notif_pending, so we need to enter vcore
323          * entry later.  Need to disable notifs so we don't get in weird loops with
324          * save_user_ctx() and pop_user_ctx(). */
325         disable_notifs(vcoreid);
326         /* take the current state and save it into t->utf when this pthread
327          * restarts, it will continue from right after this, see yielding is false,
328          * and short ciruit the function.  Don't do this if we're dying. */
329         if (save_state) {
330                 /* Need to signal this before we actually save, since save_user_ctx
331                  * returns() twice (once now, once when woken up) */
332                 uthread->flags |= UTHREAD_SAVED;
333                 save_user_ctx(&uthread->u_ctx);
334         }
335         cmb();  /* Force reread of yielding. Technically save_user_ctx() suffices*/
336         /* Restart path doesn't matter if we're dying */
337         if (!yielding)
338                 goto yield_return_path;
339         /* From here on down is only executed on the save path (not the wake up) */
340         yielding = FALSE; /* for when it starts back up */
341         /* TODO: remove this when all arches support SW contexts */
342         if (save_state && (uthread->u_ctx.type != ROS_SW_CTX)) {
343                 save_fp_state(&uthread->as);
344                 uthread->flags |= UTHREAD_FPSAVED;
345         }
346         /* Change to the transition context (both TLS (if applicable) and stack). */
347         if (__uthread_has_tls(uthread)) {
348                 set_tls_desc(get_vcpd_tls_desc(vcoreid), vcoreid);
349                 assert(current_uthread == uthread);
350                 assert(in_vcore_context());
351         } else {
352                 /* Since uthreads and vcores share TLS (it's always the vcore's TLS, the
353                  * uthread one just bootstraps from it), we need to change our state at
354                  * boundaries between the two 'contexts' */
355                 __vcore_context = TRUE;
356         }
357         /* After this, make sure you don't use local variables.  Also, make sure the
358          * compiler doesn't use them without telling you (TODO).
359          *
360          * In each arch's set_stack_pointer, make sure you subtract off as much room
361          * as you need to any local vars that might be pushed before calling the
362          * next function, or for whatever other reason the compiler/hardware might
363          * walk up the stack a bit when calling a noreturn function. */
364         set_stack_pointer((void*)vcpd->transition_stack);
365         /* Finish exiting in another function. */
366         __uthread_yield();
367         /* Should never get here */
368         assert(0);
369         /* Will jump here when the uthread's trapframe is restarted/popped. */
370 yield_return_path:
371         printd("[U] Uthread %08p returning from a yield!\n", uthread);
372 }
373
374 /* We explicitly don't support sleep(), since old callers of it have
375  * expectations of being woken up by signal handlers.  If we need that, we can
376  * build it in to sleep() later.  If you just want to sleep for a while, call
377  * this helper. */
378 void uthread_sleep(unsigned int seconds)
379 {
380         sys_block(seconds * 1000000);   /* usec sleep */
381 }
382 /* If we are providing a dummy sleep function, might as well provide the more
383  * accurate/useful one. */
384 void uthread_usleep(unsigned int usecs)
385 {
386         sys_block(usecs);       /* usec sleep */
387 }
388
389 /* Cleans up the uthread (the stuff we did in uthread_init()).  If you want to
390  * destroy a currently running uthread, you'll want something like
391  * pthread_exit(), which yields, and calls this from its sched_ops yield. */
392 void uthread_cleanup(struct uthread *uthread)
393 {
394         printd("[U] thread %08p on vcore %d is DYING!\n", uthread, vcore_id());
395         /* we alloc and manage the TLS, so lets get rid of it, except for thread0.
396          * glibc owns it.  might need to keep it around for a full exit() */
397         if (__uthread_has_tls(uthread) && !(uthread->flags & UTHREAD_IS_THREAD0))
398                 __uthread_free_tls(uthread);
399 }
400
401 static void __ros_syscall_spinon(struct syscall *sysc)
402 {
403         while (!(atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS)))
404                 cpu_relax();
405 }
406
407 /* Attempts to block on sysc, returning when it is done or progress has been
408  * made. */
409 void __ros_mcp_syscall_blockon(struct syscall *sysc)
410 {
411         /* even if we are in 'vcore context', an _S can block */
412         if (!in_multi_mode()) {
413                 /* the SCP could have an alarm set to abort this sysc.  When we have a
414                  * uth blocked on a sysc, we want this pointer set up (like we do below
415                  * for MCP)s */
416                 current_uthread->sysc = sysc;
417                 __ros_scp_syscall_blockon(sysc);
418                 current_uthread->sysc = 0;
419                 return;
420         }
421         /* MCP vcore's don't know what to do yet, so we have to spin */
422         if (in_vcore_context()) {
423                 __ros_syscall_spinon(sysc);
424                 return;
425         }
426         /* At this point, we know we're a uthread in an MCP.  If we're a
427          * DONT_MIGRATE uthread, then it's disabled notifs and is basically in
428          * vcore context, enough so that it can't call into the 2LS. */
429         assert(current_uthread);
430         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
431                 assert(!notif_is_enabled(vcore_id()));  /* catch bugs */
432                 __ros_syscall_spinon(sysc);
433         }
434         /* double check before doing all this crap */
435         if (atomic_read(&sysc->flags) & (SC_DONE | SC_PROGRESS))
436                 return;
437         /* for both debugging and syscall cancelling */
438         current_uthread->sysc = sysc;
439         /* yield, calling 2ls-blockon(cur_uth, sysc) on the other side */
440         uthread_yield(TRUE, sched_ops->thread_blockon_sysc, sysc);
441 }
442
443 /* Simply sets current uthread to be whatever the value of uthread is.  This
444  * can be called from outside of sched_entry() to highjack the current context,
445  * and make sure that the new uthread struct is used to store this context upon
446  * yielding, etc. USE WITH EXTREME CAUTION! */
447 void highjack_current_uthread(struct uthread *uthread)
448 {
449         uint32_t vcoreid = vcore_id();
450         assert(uthread != current_uthread);
451         current_uthread->state = UT_NOT_RUNNING;
452         uthread->state = UT_RUNNING;
453         /* Make sure the vcore is tracking the new uthread struct */
454         if (__uthread_has_tls(current_uthread))
455                 vcore_set_tls_var(current_uthread, uthread);
456         else
457                 current_uthread = uthread;
458         /* and make sure we are using the correct TLS for the new uthread */
459         if (__uthread_has_tls(uthread)) {
460                 assert(uthread->tls_desc);
461                 set_tls_desc(uthread->tls_desc, vcoreid);
462                 __vcoreid = vcoreid;    /* setting the uthread's TLS var */
463         }
464 }
465
466 /* Helper: loads a uthread's TLS on this vcore, if applicable.  If our uthreads
467  * do not have their own TLS, we simply switch the __vc_ctx, signalling that the
468  * context running here is (soon to be) a uthread. */
469 static void set_uthread_tls(struct uthread *uthread, uint32_t vcoreid)
470 {
471         if (__uthread_has_tls(uthread)) {
472                 set_tls_desc(uthread->tls_desc, vcoreid);
473                 __vcoreid = vcoreid;    /* setting the uthread's TLS var */
474         } else {
475                 __vcore_context = FALSE;
476         }
477 }
478
479 /* Attempts to handle a fault for uth, etc */
480 static void handle_refl_fault(struct uthread *uth, struct user_context *ctx)
481 {
482         sched_ops->thread_refl_fault(uth, __arch_refl_get_nr(ctx),
483                                      __arch_refl_get_err(ctx),
484                                      __arch_refl_get_aux(ctx));
485 }
486
487 /* Run the thread that was current_uthread, from a previous run.  Should be
488  * called only when the uthread already was running, and we were interrupted by
489  * the kernel (event, etc).  Do not call this to run a fresh uthread, even if
490  * you've set it to be current. */
491 void run_current_uthread(void)
492 {
493         struct uthread *uth;
494         uint32_t vcoreid = vcore_id();
495         struct preempt_data *vcpd = vcpd_of(vcoreid);
496         assert(current_uthread);
497         assert(current_uthread->state == UT_RUNNING);
498         /* Uth was already running, should not have been saved */
499         assert(!(current_uthread->flags & UTHREAD_SAVED));
500         assert(!(current_uthread->flags & UTHREAD_FPSAVED));
501         printd("[U] Vcore %d is restarting uthread %08p\n", vcoreid,
502                current_uthread);
503         if (has_refl_fault(&vcpd->uthread_ctx)) {
504                 clear_refl_fault(&vcpd->uthread_ctx);
505                 /* we preemptively copy out and make non-running, so that there is a
506                  * consistent state for the handler.  it can then block the uth or
507                  * whatever. */
508                 uth = current_uthread;
509                 current_uthread = 0;
510                 uth->u_ctx = vcpd->uthread_ctx;
511                 save_fp_state(&uth->as);
512                 uth->state = UT_NOT_RUNNING;
513                 uth->flags |= UTHREAD_SAVED | UTHREAD_FPSAVED;
514                 handle_refl_fault(uth, &vcpd->uthread_ctx);
515                 /* we abort no matter what.  up to the 2LS to reschedule the thread */
516                 set_stack_pointer((void*)vcpd->transition_stack);
517                 vcore_entry();
518         }
519         /* Go ahead and start the uthread */
520         set_uthread_tls(current_uthread, vcoreid);
521         /* Run, using the TF in the VCPD.  FP state should already be loaded */
522         pop_user_ctx(&vcpd->uthread_ctx, vcoreid);
523         assert(0);
524 }
525
526 /* Launches the uthread on the vcore.  Don't call this on current_uthread. 
527  *
528  * In previous versions of this, we used to check for events after setting
529  * current_uthread.  That is super-dangerous.  handle_events() doesn't always
530  * return (which we used to handle), and it may also clear current_uthread.  We
531  * needed to save uthread in current_uthread, in case we didn't return.  If we
532  * didn't return, the vcore started over at vcore_entry, with current set.  When
533  * this happens, we never actually had loaded cur_uth's FP and GP onto the core,
534  * so cur_uth fails.  Check out 4602599be for more info.
535  *
536  * Ultimately, handling events again in these 'popping helpers' isn't even
537  * necessary (we only must do it once for an entire time in VC ctx, and in
538  * loops), and might have been optimizing a rare event at a cost in both
539  * instructions and complexity. */
540 void run_uthread(struct uthread *uthread)
541 {
542         uint32_t vcoreid = vcore_id();
543         struct preempt_data *vcpd = vcpd_of(vcoreid);
544         assert(!current_uthread);
545         assert(uthread->state == UT_NOT_RUNNING);
546         assert(uthread->flags & UTHREAD_SAVED);
547         /* For HW CTX, FPSAVED must match UTH SAVE (and both be on here).  For SW,
548          * FP should never be saved. */
549         if (uthread->u_ctx.type == ROS_HW_CTX)
550                 assert(uthread->flags & UTHREAD_FPSAVED);
551         else
552                 assert(!(uthread->flags & UTHREAD_FPSAVED));
553         if (has_refl_fault(&uthread->u_ctx)) {
554                 clear_refl_fault(&uthread->u_ctx);
555                 handle_refl_fault(uthread, &uthread->u_ctx);
556                 /* we abort no matter what.  up to the 2LS to reschedule the thread */
557                 set_stack_pointer((void*)vcpd->transition_stack);
558                 vcore_entry();
559         }
560         uthread->state = UT_RUNNING;
561         /* Save a ptr to the uthread we'll run in the transition context's TLS */
562         current_uthread = uthread;
563         if (uthread->flags & UTHREAD_FPSAVED) {
564                 uthread->flags &= ~UTHREAD_FPSAVED;
565                 restore_fp_state(&uthread->as);
566         }
567         set_uthread_tls(uthread, vcoreid);
568         /* the uth's context will soon be in the cpu (or VCPD), no longer saved */
569         uthread->flags &= ~UTHREAD_SAVED;
570         pop_user_ctx(&uthread->u_ctx, vcoreid);
571         assert(0);
572 }
573
574 /* Runs the uthread, but doesn't care about notif pending.  Only call this when
575  * there was a DONT_MIGRATE uthread, or a similar situation where the uthread
576  * will check messages soon (like calling enable_notifs()). */
577 static void __run_current_uthread_raw(void)
578 {
579         uint32_t vcoreid = vcore_id();
580         struct preempt_data *vcpd = vcpd_of(vcoreid);
581         if (has_refl_fault(&vcpd->uthread_ctx)) {
582                 printf("Raw / DONT_MIGRATE uthread took a fault, exiting.\n");
583                 exit(-1);
584         }
585         /* We need to manually say we have a notif pending, so we eventually return
586          * to vcore context.  (note the kernel turned it off for us) */
587         vcpd->notif_pending = TRUE;
588         assert(!(current_uthread->flags & UTHREAD_SAVED));
589         assert(!(current_uthread->flags & UTHREAD_FPSAVED));
590         set_uthread_tls(current_uthread, vcoreid);
591         pop_user_ctx_raw(&vcpd->uthread_ctx, vcoreid);
592         assert(0);
593 }
594
595 /* Copies the uthread trapframe and silly state from the vcpd to the uthread,
596  * subject to the uthread's flags and whatnot.
597  *
598  * For example: The uthread state might still be in the uthread struct.  Imagine
599  * the 2LS decides to run a new uthread and sets it up as current, but doesn't
600  * actually run it yet.  The 2LS happened to voluntarily give up the VC (due to
601  * some other event) and then wanted to copy out the thread.  This is pretty
602  * rare - the normal case is when an IRQ of some sort hit the core and the
603  * kernel copied the running state into VCPD.
604  *
605  * The FP state could also be in VCPD (e.g. preemption being handled remotely),
606  * it could be in the uthread struct (e.g. hasn't started running yet) or even
607  * in the FPU (e.g. took an IRQ/notif and we're handling the preemption of
608  * another vcore).
609  *
610  * There are some cases where we'll have a uthread SW ctx that needs to be
611  * copied out: uth syscalls, notif happens, and the core comes back from the
612  * kernel in VC ctx.  VC ctx calls copy_out (response to preempt_pending or done
613  * while handling a preemption). */
614 static void copyout_uthread(struct preempt_data *vcpd, struct uthread *uthread,
615                             bool vcore_local)
616 {
617         assert(uthread);
618         if (uthread->flags & UTHREAD_SAVED) {
619                 /* I don't know of scenarios where HW ctxs FP state differs from GP */
620                 if (uthread->u_ctx.type == ROS_HW_CTX)
621                         assert(uthread->flags & UTHREAD_FPSAVED);
622                 assert(vcore_local);
623                 return;
624         }
625         /* If we're copying GP state, it must be in VCPD */
626         uthread->u_ctx = vcpd->uthread_ctx;
627         uthread->flags |= UTHREAD_SAVED;
628         printd("VC %d copying out uthread %08p\n", vcore_id(), uthread);
629         /* Software contexts do not need FP state, nor should we think it has any */
630         if (uthread->u_ctx.type == ROS_SW_CTX) {
631                 assert(!(uthread->flags & UTHREAD_FPSAVED));
632                 return;
633         }
634         /* HW contexts also should not have it saved either.  Should be either in
635          * the VCPD or the FPU.  Yes, this is the same assert. */
636         assert(!(uthread->flags & UTHREAD_FPSAVED));
637         /* When we're dealing with the uthread running on our own vcore, the FP
638          * state is in the actual FPU, not VCPD.  It might also be in VCPD, but it
639          * will always be in the FPU (the kernel maintains this for us, in the event
640          * we were preempted since the uthread was last running). */
641         if (vcore_local)
642                 save_fp_state(&uthread->as);
643         else
644                 uthread->as = vcpd->preempt_anc;
645         uthread->flags |= UTHREAD_FPSAVED;
646 }
647
648 /* Helper, packages up and pauses a uthread that was running on vcoreid.  Used
649  * by preemption handling (and detection) so far.  Careful using this, esp if
650  * it is on another vcore (need to make sure it's not running!).  If you are
651  * using it on the local vcore, set vcore_local = TRUE. */
652 static void __uthread_pause(struct preempt_data *vcpd, struct uthread *uthread,
653                             bool vcore_local)
654 {
655         assert(!(uthread->flags & UTHREAD_DONT_MIGRATE));
656         copyout_uthread(vcpd, uthread, vcore_local);
657         uthread->state = UT_NOT_RUNNING;
658         /* Call out to the 2LS to package up its uthread */
659         assert(sched_ops->thread_paused);
660         sched_ops->thread_paused(uthread);
661 }
662
663 /* Deals with a pending preemption (checks, responds).  If the 2LS registered a
664  * function, it will get run.  Returns true if you got preempted.  Called
665  * 'check' instead of 'handle', since this isn't an event handler.  It's the "Oh
666  * shit a preempt is on its way ASAP".
667  *
668  * Be careful calling this: you might not return, so don't call it if you can't
669  * handle that.  If you are calling this from an event handler, you'll need to
670  * do things like ev_might_not_return().  If the event can via an INDIR ev_q,
671  * that ev_q must be a NOTHROTTLE.
672  *
673  * Finally, don't call this from a place that might have a DONT_MIGRATE
674  * cur_uth.  This should be safe for most 2LS code. */
675 bool __check_preempt_pending(uint32_t vcoreid)
676 {
677         bool retval = FALSE;
678         assert(in_vcore_context());
679         if (__preempt_is_pending(vcoreid)) {
680                 retval = TRUE;
681                 if (sched_ops->preempt_pending)
682                         sched_ops->preempt_pending();
683                 /* If we still have a cur_uth, copy it out and hand it back to the 2LS
684                  * before yielding. */
685                 if (current_uthread) {
686                         __uthread_pause(vcpd_of(vcoreid), current_uthread, TRUE);
687                         current_uthread = 0;
688                 }
689                 /* vcore_yield tries to yield, and will pop back up if this was a spurious
690                  * preempt_pending or if it handled an event.  For now, we'll just keep
691                  * trying to yield so long as a preempt is coming in.  Eventually, we'll
692                  * handle all of our events and yield, or else the preemption will hit
693                  * and someone will recover us (at which point we'll break out of the
694                  * loop) */
695                 while (__procinfo.vcoremap[vcoreid].preempt_pending) {
696                         vcore_yield(TRUE);
697                         cpu_relax();
698                 }
699         }
700         return retval;
701 }
702
703 /* Helper: This is a safe way for code to disable notifs if it *might* be called
704  * from uthread context (like from a notif_safe lock).  Pair this with
705  * uth_enable_notifs() unless you know what you're doing. */
706 void uth_disable_notifs(void)
707 {
708         if (!in_vcore_context() && in_multi_mode()) {
709                 if (__uth_disable_depth++)
710                         return;
711                 if (current_uthread)
712                         current_uthread->flags |= UTHREAD_DONT_MIGRATE;
713                 cmb();  /* don't issue the flag write before the vcore_id() read */
714                 disable_notifs(vcore_id());
715         }
716 }
717
718 /* Helper: Pair this with uth_disable_notifs(). */
719 void uth_enable_notifs(void)
720 {
721         if (!in_vcore_context() && in_multi_mode()) {
722                 if (--__uth_disable_depth)
723                         return;
724                 if (current_uthread)
725                         current_uthread->flags &= ~UTHREAD_DONT_MIGRATE;
726                 cmb();  /* don't enable before ~DONT_MIGRATE */
727                 enable_notifs(vcore_id());
728         }
729 }
730
731 /* Helper: returns TRUE if it succeeded in starting the uth stealing process. */
732 static bool start_uth_stealing(struct preempt_data *vcpd)
733 {
734         long old_flags;
735         do {
736                 old_flags = atomic_read(&vcpd->flags);
737                 /* Spin if the kernel is mucking with the flags */
738                 while (old_flags & VC_K_LOCK)
739                         old_flags = atomic_read(&vcpd->flags);
740                 /* Someone else is stealing, we failed */
741                 if (old_flags & VC_UTHREAD_STEALING)
742                         return FALSE;
743         } while (!atomic_cas(&vcpd->flags, old_flags,
744                              old_flags | VC_UTHREAD_STEALING));
745         return TRUE;
746 }
747
748 /* Helper: pairs with stop_uth_stealing */
749 static void stop_uth_stealing(struct preempt_data *vcpd)
750 {
751         long old_flags;
752         do {
753                 old_flags = atomic_read(&vcpd->flags);
754                 assert(old_flags & VC_UTHREAD_STEALING);        /* sanity */
755                 while (old_flags & VC_K_LOCK)
756                         old_flags = atomic_read(&vcpd->flags);
757         } while (!atomic_cas(&vcpd->flags, old_flags,
758                              old_flags & ~VC_UTHREAD_STEALING));
759 }
760
761 /* Handles INDIRS for another core (the public mbox).  We synchronize with the
762  * kernel (__set_curtf_to_vcoreid). */
763 static void handle_indirs(uint32_t rem_vcoreid)
764 {
765         long old_flags;
766         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
767         /* Turn off their message reception if they are still preempted.  If they
768          * are no longer preempted, we do nothing - they will handle their own
769          * messages.  Turning on CAN_RCV will route this vcore's messages to
770          * fallback vcores (if applicable). */
771         do {
772                 old_flags = atomic_read(&rem_vcpd->flags);
773                 while (old_flags & VC_K_LOCK)
774                         old_flags = atomic_read(&rem_vcpd->flags);
775                 if (!(old_flags & VC_PREEMPTED))
776                         return;
777         } while (!atomic_cas(&rem_vcpd->flags, old_flags,
778                              old_flags & ~VC_CAN_RCV_MSG));
779         wrmb(); /* don't let the CAN_RCV write pass reads of the mbox status */
780         /* handle all INDIRs of the remote vcore */
781         handle_vcpd_mbox(rem_vcoreid);
782 }
783
784 /* Helper.  Will ensure a good attempt at changing vcores, meaning we try again
785  * if we failed for some reason other than the vcore was already running. */
786 static void __change_vcore(uint32_t rem_vcoreid, bool enable_my_notif)
787 {
788         /* okay to do a normal spin/relax here, even though we are in vcore
789          * context. */
790         while (-EAGAIN == sys_change_vcore(rem_vcoreid, enable_my_notif))
791                 cpu_relax();
792 }
793
794 /* Helper, used in preemption recovery.  When you can freely leave vcore
795  * context and need to change to another vcore, call this.  vcpd is the caller,
796  * rem_vcoreid is the remote vcore.  This will try to package up your uthread.
797  * It may return, either because the other core already started up (someone else
798  * got it), or in some very rare cases where we had to stay in our vcore
799  * context */
800 static void change_to_vcore(struct preempt_data *vcpd, uint32_t rem_vcoreid)
801 {
802         bool were_handling_remotes;
803         /* Unlikely, but if we have no uthread we can just change.  This is the
804          * check, sync, then really check pattern: we can only really be sure about
805          * current_uthread after we check STEALING. */
806         if (!current_uthread) {
807                 /* there might be an issue with doing this while someone is recovering.
808                  * once they 0'd it, we should be good to yield.  just a bit dangerous.
809                  * */
810                 were_handling_remotes = ev_might_not_return();
811                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
812                 goto out_we_returned;
813         }
814         /* Note that the reason we need to check STEALING is because we can get into
815          * vcore context and slip past that check in vcore_entry when we are
816          * handling a preemption message.  Anytime preemption recovery cares about
817          * the calling vcore's cur_uth, it needs to be careful about STEALING.  But
818          * it is safe to do the check up above (if it's 0, it won't concurrently
819          * become non-zero).
820          *
821          * STEALING might be turned on at any time.  Whoever turns it on will do
822          * nothing if we are online or were in vc_ctx.  So if it is on, we can't
823          * touch current_uthread til it is turned off (not sure what state they saw
824          * us in).  We could spin here til they unset STEALING (since they will
825          * soon), but there is a chance they were preempted, so we need to make
826          * progress by doing a sys_change_vcore(). */
827         /* Crap, someone is stealing (unlikely).  All we can do is change. */
828         if (atomic_read(&vcpd->flags) & VC_UTHREAD_STEALING) {
829                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
830                 return;
831         }
832         cmb();
833         /* Need to recheck, in case someone stole it and finished before we checked
834          * VC_UTHREAD_STEALING. */
835         if (!current_uthread) {
836                 were_handling_remotes = ev_might_not_return();
837                 __change_vcore(rem_vcoreid, TRUE);      /* noreturn on success */
838                 goto out_we_returned;
839         }
840         /* Need to make sure we don't have a DONT_MIGRATE (very rare, someone would
841          * have to steal from us to get us to handle a preempt message, and then had
842          * to finish stealing (and fail) fast enough for us to miss the previous
843          * check). */
844         if (current_uthread->flags & UTHREAD_DONT_MIGRATE) {
845                 __change_vcore(rem_vcoreid, FALSE);     /* returns on success */
846                 return;
847         }
848         /* Now save our uthread and restart them */
849         assert(current_uthread);
850         __uthread_pause(vcpd, current_uthread, TRUE);
851         current_uthread = 0;
852         were_handling_remotes = ev_might_not_return();
853         __change_vcore(rem_vcoreid, TRUE);              /* noreturn on success */
854         /* Fall-through to out_we_returned */
855 out_we_returned:
856         ev_we_returned(were_handling_remotes);
857 }
858
859 /* This handles a preemption message.  When this is done, either we recovered,
860  * or recovery *for our message* isn't needed. */
861 static void handle_vc_preempt(struct event_msg *ev_msg, unsigned int ev_type,
862                               void *data)
863 {
864         uint32_t vcoreid = vcore_id();
865         struct preempt_data *vcpd = vcpd_of(vcoreid);
866         uint32_t rem_vcoreid = ev_msg->ev_arg2;
867         struct preempt_data *rem_vcpd = vcpd_of(rem_vcoreid);
868         struct uthread *uthread_to_steal = 0;
869         struct uthread **rem_cur_uth;
870         bool cant_migrate = FALSE;
871
872         assert(in_vcore_context());
873         /* Just drop messages about ourselves.  They are old.  If we happen to be
874          * getting preempted right now, there's another message out there about
875          * that. */
876         if (rem_vcoreid == vcoreid)
877                 return;
878         printd("Vcore %d was preempted (i'm %d), it's flags %08p!\n",
879                ev_msg->ev_arg2, vcoreid, rem_vcpd->flags);
880         /* Spin til the kernel is done with flags.  This is how we avoid handling
881          * the preempt message before the preemption. */
882         while (atomic_read(&rem_vcpd->flags) & VC_K_LOCK)
883                 cpu_relax();
884         /* If they aren't preempted anymore, just return (optimization). */
885         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
886                 return;
887         /* At this point, we need to try to recover */
888         /* This case handles when the remote core was in vcore context */
889         if (rem_vcpd->notif_disabled) {
890                 printd("VC %d recovering %d, notifs were disabled\n", vcoreid,
891                        rem_vcoreid);
892                 change_to_vcore(vcpd, rem_vcoreid);
893                 return; /* in case it returns.  we've done our job recovering */
894         }
895         /* So now it looks like they were not in vcore context.  We want to steal
896          * the uthread.  Set stealing, then doublecheck everything.  If stealing
897          * fails, someone else is stealing and we can just leave.  That other vcore
898          * who is stealing will check the VCPD/INDIRs when it is done. */
899         if (!start_uth_stealing(rem_vcpd))
900                 return;
901         /* Now we're stealing.  Double check everything.  A change in preempt status
902          * or notif_disable status means the vcore has since restarted.  The vcore
903          * may or may not have started after we set STEALING.  If it didn't, we'll
904          * need to bail out (but still check messages, since above we assumed the
905          * uthread stealer handles the VCPD/INDIRs).  Since the vcore is running, we
906          * don't need to worry about handling the message any further.  Future
907          * preemptions will generate another message, so we can ignore getting the
908          * uthread or anything like that. */
909         printd("VC %d recovering %d, trying to steal uthread\n", vcoreid,
910                rem_vcoreid);
911         if (!(atomic_read(&rem_vcpd->flags) & VC_PREEMPTED))
912                 goto out_stealing;
913         /* Might be preempted twice quickly, and the second time had notifs
914          * disabled.
915          *
916          * Also note that the second preemption event had another
917          * message sent, which either we or someone else will deal with.  And also,
918          * we don't need to worry about how we are stealing still and plan to
919          * abort.  If another vcore handles that second preemption message, either
920          * the original vcore is in vc ctx or not.  If so, we bail out and the
921          * second preemption handling needs to change_to.  If not, we aren't
922          * bailing out, and we'll handle the preemption as normal, and the second
923          * handler will bail when it fails to steal. */
924         if (rem_vcpd->notif_disabled)
925                 goto out_stealing;
926         /* At this point, we're clear to try and steal the uthread.  We used to
927          * switch to their TLS to steal the uthread, but we can access their
928          * current_uthread directly. */
929         rem_cur_uth = get_cur_uth_addr(rem_vcoreid);
930         uthread_to_steal = *rem_cur_uth;
931         if (uthread_to_steal) {
932                 /* Extremely rare: they have a uthread, but it can't migrate.  So we'll
933                  * need to change to them. */
934                 if (uthread_to_steal->flags & UTHREAD_DONT_MIGRATE) {
935                         printd("VC %d recovering %d, can't migrate uthread!\n", vcoreid,
936                                rem_vcoreid);
937                         stop_uth_stealing(rem_vcpd);
938                         change_to_vcore(vcpd, rem_vcoreid);
939                         return; /* in case it returns.  we've done our job recovering */
940                 } else {
941                         *rem_cur_uth = 0;
942                         /* we're clear to steal it */
943                         printd("VC %d recovering %d, uthread %08p stolen\n", vcoreid,
944                                rem_vcoreid, uthread_to_steal);
945                         __uthread_pause(rem_vcpd, uthread_to_steal, FALSE);
946                         /* can't let the cur_uth = 0 write and any writes from __uth_pause()
947                          * to pass stop_uth_stealing. */
948                         wmb();
949                 }
950         }
951         /* Fallthrough */
952 out_stealing:
953         stop_uth_stealing(rem_vcpd);
954         handle_indirs(rem_vcoreid);
955 }
956
957 /* This handles a "check indirs" message.  When this is done, either we checked
958  * their indirs, or the vcore restarted enough so that checking them is
959  * unnecessary.  If that happens and they got preempted quickly, then another
960  * preempt/check_indirs was sent out. */
961 static void handle_vc_indir(struct event_msg *ev_msg, unsigned int ev_type,
962                             void *data)
963 {
964         uint32_t vcoreid = vcore_id();
965         uint32_t rem_vcoreid = ev_msg->ev_arg2;
966
967         if (rem_vcoreid == vcoreid)
968                 return;
969         handle_indirs(rem_vcoreid);
970 }
971
972 /* Attempts to register ev_q with sysc, so long as sysc is not done/progress.
973  * Returns true if it succeeded, and false otherwise.  False means that the
974  * syscall is done, and does not need an event set (and should be handled
975  * accordingly).
976  * 
977  * A copy of this is in glibc/sysdeps/ros/syscall.c.  Keep them in sync. */
978 bool register_evq(struct syscall *sysc, struct event_queue *ev_q)
979 {
980         int old_flags;
981         sysc->ev_q = ev_q;
982         wrmb(); /* don't let that write pass any future reads (flags) */
983         /* Try and set the SC_UEVENT flag (so the kernel knows to look at ev_q) */
984         do {
985                 /* no cmb() needed, the atomic_read will reread flags */
986                 old_flags = atomic_read(&sysc->flags);
987                 /* Spin if the kernel is mucking with syscall flags */
988                 while (old_flags & SC_K_LOCK)
989                         old_flags = atomic_read(&sysc->flags);
990                 /* If the kernel finishes while we are trying to sign up for an event,
991                  * we need to bail out */
992                 if (old_flags & (SC_DONE | SC_PROGRESS)) {
993                         sysc->ev_q = 0;         /* not necessary, but might help with bugs */
994                         return FALSE;
995                 }
996         } while (!atomic_cas(&sysc->flags, old_flags, old_flags | SC_UEVENT));
997         return TRUE;
998 }
999
1000 /* De-registers a syscall, so that the kernel will not send an event when it is
1001  * done.  The call could already be SC_DONE, or could even finish while we try
1002  * to unset SC_UEVENT.
1003  *
1004  * There is a chance the kernel sent an event if you didn't do this in time, but
1005  * once this returns, the kernel won't send a message.
1006  *
1007  * If the kernel is trying to send a message right now, this will spin (on
1008  * SC_K_LOCK).  We need to make sure we deregistered, and that if a message
1009  * is coming, that it already was sent (and possibly overflowed), before
1010  * returning. */
1011 void deregister_evq(struct syscall *sysc)
1012 {
1013         int old_flags;
1014         sysc->ev_q = 0;
1015         wrmb(); /* don't let that write pass any future reads (flags) */
1016         /* Try and unset the SC_UEVENT flag */
1017         do {
1018                 /* no cmb() needed, the atomic_read will reread flags */
1019                 old_flags = atomic_read(&sysc->flags);
1020                 /* Spin if the kernel is mucking with syscall flags */
1021                 while (old_flags & SC_K_LOCK)
1022                         old_flags = atomic_read(&sysc->flags);
1023                 /* Note we don't care if the SC_DONE flag is getting set.  We just need
1024                  * to avoid clobbering flags */
1025         } while (!atomic_cas(&sysc->flags, old_flags, old_flags & ~SC_UEVENT));
1026 }
1027
1028 static inline bool __uthread_has_tls(struct uthread *uthread)
1029 {
1030         return uthread->tls_desc != UTH_TLSDESC_NOTLS;
1031 }
1032
1033 /* TLS helpers */
1034 static int __uthread_allocate_tls(struct uthread *uthread)
1035 {
1036         assert(!uthread->tls_desc);
1037         uthread->tls_desc = allocate_tls();
1038         if (!uthread->tls_desc) {
1039                 errno = ENOMEM;
1040                 return -1;
1041         }
1042         return 0;
1043 }
1044
1045 static int __uthread_reinit_tls(struct uthread *uthread)
1046 {
1047         uthread->tls_desc = reinit_tls(uthread->tls_desc);
1048         if (!uthread->tls_desc) {
1049                 errno = ENOMEM;
1050                 return -1;
1051         }
1052         return 0;
1053 }
1054
1055 static void __uthread_free_tls(struct uthread *uthread)
1056 {
1057         free_tls(uthread->tls_desc);
1058         uthread->tls_desc = NULL;
1059 }