2LS thread_blockon now takes the uthread*
[akaros.git] / user / parlib / include / uthread.h
1 #ifndef _UTHREAD_H
2 #define _UTHREAD_H
3
4 #include <vcore.h>
5 #include <ros/syscall.h>
6
7 #define UTHREAD_DONT_MIGRATE            0x001 /* don't move to another vcore */
8 #define UTHREAD_SAVED                           0x002 /* uthread's state is in utf */
9 #define UTHREAD_FPSAVED                         0x004 /* uthread's FP state is in uth->as */
10
11 /* Thread States */
12 #define UT_RUNNING              1
13 #define UT_NOT_RUNNING  2
14
15 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
16  * cast their threads to uthreads when talking with vcore code.  Vcore/default
17  * 2LS code won't touch udata or beyond. */
18 struct uthread {
19         struct user_trapframe utf;
20         struct ancillary_state as;
21         void *tls_desc;
22         int flags;
23         struct syscall *sysc;   /* syscall we're blocking on, if any */
24         int state;
25 };
26 typedef struct uthread uthread_t;
27 extern __thread struct uthread *current_uthread;
28
29 /* 2L-Scheduler operations.  Can be 0.  Examples in pthread.c. */
30 struct schedule_ops {
31         /* Functions supporting thread ops */
32         void (*sched_entry)(void);
33         void (*thread_runnable)(struct uthread *);
34         void (*thread_yield)(struct uthread *);
35         void (*thread_paused)(struct uthread *);
36         void (*thread_blockon_sysc)(struct uthread *, void *);
37         /* Functions event handling wants */
38         void (*preempt_pending)(void);
39         void (*spawn_thread)(uintptr_t pc_start, void *data);   /* don't run yet */
40 };
41 extern struct schedule_ops *sched_ops;
42
43 /* Call this, passing it a uthread representing thread0, from your 2LS init
44  * routines.  When it returns, you're in _M mode (thread0 on vcore0) */
45 int uthread_lib_init(struct uthread *uthread);
46
47 /* Functions to make/manage uthreads.  Can be called by functions such as
48  * pthread_create(), which can wrap these with their own stuff (like attrs,
49  * retvals, etc). */
50
51 /* Does the uthread initialization of a uthread that the caller created.  Call
52  * this whenever you are "starting over" with a thread. */
53 void uthread_init(struct uthread *new_thread);
54 /* Low-level _S code calls this for basic uthreading without a 2LS */
55 void uthread_slim_init(void);
56 /* Call this when you are done with a uthread, forever, but before you free it */
57 void uthread_cleanup(struct uthread *uthread);
58 void uthread_runnable(struct uthread *uthread);
59 void uthread_yield(bool save_state);
60
61 /* Utility functions */
62 bool __check_preempt_pending(uint32_t vcoreid); /* careful: check the code */
63 void uth_disable_notifs(void);
64 void uth_enable_notifs(void);
65 void copyout_uthread(struct preempt_data *vcpd, struct uthread *uthread);
66
67 bool register_evq(struct syscall *sysc, struct event_queue *ev_q);
68 void deregister_evq(struct syscall *sysc);
69
70 /* Helpers, which sched_entry() can call */
71 void highjack_current_uthread(struct uthread *uthread);
72 void run_current_uthread(void);
73 void run_uthread(struct uthread *uthread);
74
75 static inline void
76 init_uthread_tf(uthread_t *uth, void (*entry)(void),
77                 void *stack_bottom, uint32_t size)
78 {
79   init_user_tf(&uth->utf, (long)entry, (long)(stack_bottom));
80 }
81
82 #define uthread_set_tls_var(uthread, name, val)                          \
83 {                                                                        \
84       typeof(val) __val = val;                                           \
85       begin_access_tls_vars(((uthread_t*)(uthread))->tls_desc);          \
86       name = __val;                                                      \
87       end_access_tls_vars();                                             \
88 }
89
90 #define uthread_get_tls_var(uthread, name)                               \
91 ({                                                                       \
92       typeof(name) val;                                                  \
93       begin_access_tls_vars(((uthread_t*)(uthread))->tls_desc);          \
94       val = name;                                                        \
95       end_access_tls_vars();                                             \
96       val;                                                               \
97 })
98
99 #endif /* _UTHREAD_H */