parlib: Always use the default mutex/cv interface
[akaros.git] / user / parlib / include / parlib / uthread.h
1 #pragma once
2
3 #include <parlib/vcore.h>
4 #include <parlib/signal.h>
5 #include <parlib/spinlock.h>
6 #include <ros/syscall.h>
7 #include <sys/queue.h>
8
9 __BEGIN_DECLS
10
11 #define UTHREAD_DONT_MIGRATE            0x001 /* don't move to another vcore */
12 #define UTHREAD_SAVED                           0x002 /* uthread's state is in utf */
13 #define UTHREAD_FPSAVED                         0x004 /* uthread's FP state is in uth->as */
14 #define UTHREAD_IS_THREAD0                      0x008 /* thread0: glibc's main() thread */
15
16 /* Thread States */
17 #define UT_RUNNING              1
18 #define UT_NOT_RUNNING  2
19
20 /* Externally blocked thread reasons (for uthread_has_blocked()) */
21 #define UTH_EXT_BLK_MUTEX                       1
22 #define UTH_EXT_BLK_EVENTQ                      2
23 #define UTH_EXT_BLK_JUSTICE                     3       /* whatever.  might need more options */
24
25 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
26  * cast their threads to uthreads when talking with vcore code.  Vcore/default
27  * 2LS code won't touch udata or beyond. */
28 struct uthread {
29         struct user_context u_ctx;
30         struct ancillary_state as;
31         void *tls_desc;
32         int flags;
33         int state;
34         struct sigstate sigstate;
35         int notif_disabled_depth;
36         TAILQ_ENTRY(uthread) sync_next;
37         struct syscall *sysc;   /* syscall we're blocking on, if any */
38         struct syscall local_sysc;      /* for when we don't want to use the stack */
39         void (*yield_func)(struct uthread*, void*);
40         void *yield_arg;
41         int err_no;
42         char err_str[MAX_ERRSTR_LEN];
43 };
44 TAILQ_HEAD(uth_tailq, uthread);
45
46 extern __thread struct uthread *current_uthread;
47
48
49 /* This struct is undefined.  We use it instead of void * so we can get
50  * compiler warnings if someone passes the wrong pointer type.  Internally, 2LSs
51  * and the default implementation use another object type. */
52 typedef struct __uth_sync_opaque * uth_sync_t;
53
54 /* 2LS-independent synchronization code (e.g. uthread mutexes) uses these
55  * helpers to access 2LS-specific functions.
56  *
57  * Note the spinlock associated with the higher-level sync primitive is held for
58  * these (where applicable). */
59 uth_sync_t __uth_sync_alloc(void);
60 void __uth_sync_free(uth_sync_t sync);
61 struct uthread *__uth_sync_get_next(uth_sync_t sync);
62 bool __uth_sync_get_uth(uth_sync_t sync, struct uthread *uth);
63 /* 2LSs that use default sync objs will call this in their has_blocked op. */
64 void __uth_default_sync_enqueue(struct uthread *uth, uth_sync_t sync);
65
66 /* 2L-Scheduler operations.  Examples in pthread.c. */
67 struct schedule_ops {
68         /**** These functions must be defined ****/
69         /* Functions supporting thread ops */
70         void (*sched_entry)(void);
71         void (*thread_runnable)(struct uthread *);
72         void (*thread_paused)(struct uthread *);
73         void (*thread_blockon_sysc)(struct uthread *, void *);
74         void (*thread_has_blocked)(struct uthread *, uth_sync_t, int);
75         void (*thread_refl_fault)(struct uthread *, struct user_context *);
76         /**** Defining these functions is optional. ****/
77         uth_sync_t (*sync_alloc)(void);
78         void (*sync_free)(uth_sync_t);
79         struct uthread *(*sync_get_next)(uth_sync_t);
80         bool (*sync_get_uth)(uth_sync_t, struct uthread *);
81         /* Functions event handling wants */
82         void (*preempt_pending)(void);
83 };
84 extern struct schedule_ops *sched_ops;
85
86 /* Low-level _S code calls this for basic uthreading without a 2LS */
87 void uthread_lib_init(void);
88 /* Call this from your 2LS init routines.  Pass it a uthread representing
89  * thread0, your 2LS ops, and your syscall handler + data.
90  *
91  * When it returns, you're in _M mode (thread0 on vcore0) */
92 void uthread_2ls_init(struct uthread *uthread, struct schedule_ops *ops,
93                       void (*handle_sysc)(struct event_msg *, unsigned int,
94                                           void *),
95                       void *data);
96 /* Call this to become an mcp capable of worling with uthreads. */
97 void uthread_mcp_init(void);
98
99 /* Functions to make/manage uthreads.  Can be called by functions such as
100  * pthread_create(), which can wrap these with their own stuff (like attrs,
101  * retvals, etc). */
102
103 /* uthread_init() does the uthread initialization of a uthread that the caller
104  * created.  Call this whenever you are "starting over" with a thread.  Pass in
105  * attr, if you want to override any defaults. */
106 struct uth_thread_attr {
107         bool want_tls;          /* default, no */
108 };
109 void uthread_init(struct uthread *new_thread, struct uth_thread_attr *attr);
110 /* Call this when you are done with a uthread, forever, but before you free it */
111 void uthread_cleanup(struct uthread *uthread);
112 void uthread_runnable(struct uthread *uthread);
113 void uthread_yield(bool save_state, void (*yield_func)(struct uthread*, void*),
114                    void *yield_arg);
115 void uthread_sleep(unsigned int seconds);
116 void uthread_usleep(unsigned int usecs);
117 void __attribute__((noreturn)) uthread_sleep_forever(void);
118 void uthread_has_blocked(struct uthread *uthread, uth_sync_t sync, int flags);
119 void uthread_paused(struct uthread *uthread);
120
121 /* Utility functions */
122 bool __check_preempt_pending(uint32_t vcoreid); /* careful: check the code */
123 void uth_disable_notifs(void);
124 void uth_enable_notifs(void);
125
126 /* Helpers, which the 2LS can call */
127 void __block_uthread_on_async_sysc(struct uthread *uth);
128 void highjack_current_uthread(struct uthread *uthread);
129 struct uthread *stop_current_uthread(void);
130 void __attribute__((noreturn)) run_current_uthread(void);
131 void __attribute__((noreturn)) run_uthread(struct uthread *uthread);
132
133 /* Asking for trouble with this API, when we just want stacktop (or whatever
134  * the SP will be). */
135 static inline void init_uthread_ctx(struct uthread *uth, void (*entry)(void),
136                                     void *stack_bottom, uint32_t size)
137 {
138         init_user_ctx(&uth->u_ctx, (long)entry, (long)(stack_bottom) + size);
139 }
140
141 /* When we look at the current_uthread, its context might be in the uthread
142  * struct or it might be in VCPD.  This returns a pointer to the right place. */
143 static inline struct user_context *get_cur_uth_ctx(void)
144 {
145         if (current_uthread->flags & UTHREAD_SAVED)
146                 return &current_uthread->u_ctx;
147         else
148                 return &vcpd_of(vcore_id())->uthread_ctx;
149 }
150
151 #define uthread_set_tls_var(uth, name, val)                                    \
152 ({                                                                             \
153         typeof(val) __val = val;                                                   \
154         begin_access_tls_vars(((struct uthread*)(uth))->tls_desc);                 \
155         name = __val;                                                              \
156         end_access_tls_vars();                                                     \
157 })
158
159 #define uthread_get_tls_var(uth, name)                                         \
160 ({                                                                             \
161         typeof(name) val;                                                          \
162         begin_access_tls_vars(((struct uthread*)(uth))->tls_desc);                 \
163         val = name;                                                                \
164         end_access_tls_vars();                                                     \
165         val;                                                                       \
166 })
167
168 /* Uthread Mutexes / CVs / etc. */
169
170 typedef struct uth_mutex * uth_mutex_t;
171 typedef struct uth_recurse_mutex * uth_recurse_mutex_t;
172 typedef struct uth_cond_var * uth_cond_var_t;
173
174 struct uth_mutex {
175         struct spin_pdr_lock            lock;
176         uth_sync_t                                      sync_obj;
177         bool                                            locked;
178 };
179
180 struct uth_recurse_mutex {
181         uth_mutex_t                                     mtx;
182         struct uthread                          *lockholder;
183         unsigned int                            count;
184 };
185
186 struct uth_cond_var {
187         struct spin_pdr_lock            lock;
188         uth_sync_t                                      sync_obj;
189 };
190
191 uth_mutex_t uth_mutex_alloc(void);
192 void uth_mutex_free(uth_mutex_t m);
193 void uth_mutex_lock(uth_mutex_t m);
194 bool uth_mutex_trylock(uth_mutex_t m);
195 void uth_mutex_unlock(uth_mutex_t m);
196
197 uth_recurse_mutex_t uth_recurse_mutex_alloc(void);
198 void uth_recurse_mutex_free(uth_recurse_mutex_t r_m);
199 void uth_recurse_mutex_lock(uth_recurse_mutex_t r_m);
200 bool uth_recurse_mutex_trylock(uth_recurse_mutex_t r_m);
201 void uth_recurse_mutex_unlock(uth_recurse_mutex_t r_m);
202
203 /* Callers to cv_wait must hold the mutex, which it will atomically wait and
204  * unlock, then relock when it returns.  Callers to signal and broadcast may
205  * hold the mutex, if they choose. */
206 uth_cond_var_t uth_cond_var_alloc(void);
207 void uth_cond_var_free(uth_cond_var_t cv);
208 void uth_cond_var_wait(uth_cond_var_t cv, uth_mutex_t m);
209 void uth_cond_var_signal(uth_cond_var_t cv);
210 void uth_cond_var_broadcast(uth_cond_var_t cv);
211
212 /* Called by gcc to see if we are multithreaded. */
213 bool uth_2ls_is_multithreaded(void);
214
215 __END_DECLS