pthread: Make pthread barriers 2LS-independent
[akaros.git] / user / pthread / pthread.h
1 #pragma once
2
3 #include <sys/queue.h>
4 #include <signal.h>
5 #include <parlib/vcore.h>
6 #include <parlib/uthread.h>
7 #include <parlib/mcs.h>
8 #include <parlib/dtls.h>
9 #include <parlib/spinlock.h>
10 #include <parlib/signal.h>
11 #include <parlib/parlib.h>
12 /* GNU / POSIX scheduling crap */
13 #include <sched.h>
14
15 __BEGIN_DECLS
16
17 /* Pthread states.  These are mostly examples for other 2LSs */
18 #define PTH_CREATED                     1
19 #define PTH_RUNNABLE            2
20 #define PTH_RUNNING                     3
21 #define PTH_EXITING                     4
22 #define PTH_BLK_YIELDING        5       /* brief state btw pth_yield and pth_runnable */
23 #define PTH_BLK_SYSC            6       /* blocked on a syscall */
24 #define PTH_BLK_MUTEX           7       /* blocked externally, possibly on a mutex */
25 #define PTH_BLK_PAUSED          8       /* handed back to us from uthread code */
26 #define PTH_BLK_MISC            9       /* catch-all from uthread code */
27
28 /* Entry for a pthread_cleanup_routine on the stack of cleanup handlers. */
29 struct pthread_cleanup_routine {
30         SLIST_ENTRY(pthread_cleanup_routine) cr_next;
31         void (*routine)(void *);
32         void *arg;
33 };
34 SLIST_HEAD(pthread_cleanup_stack, pthread_cleanup_routine);
35
36 /* Pthread struct.  First has to be the uthread struct, which the vcore code
37  * will access directly (as if pthread_tcb is a struct uthread). */
38 struct pthread_tcb;
39 struct pthread_tcb {
40         struct uthread uthread;
41         TAILQ_ENTRY(pthread_tcb) tq_next;
42         int state;
43         uint32_t id;
44         uint32_t stacksize;
45         void *stacktop;
46         void *(*start_routine)(void*);
47         void *arg;
48         int sched_policy;
49         int sched_priority;             /* careful, GNU #defines this to __sched_priority */
50         struct pthread_cleanup_stack cr_stack;
51 };
52 typedef struct pthread_tcb* pthread_t;
53 TAILQ_HEAD(pthread_queue, pthread_tcb);
54
55 /* Per-vcore data structures to manage syscalls.  The ev_q is where we tell the
56  * kernel to signal us.  We don't need a lock since this is per-vcore and
57  * accessed in vcore context. */
58 struct sysc_mgmt {
59         struct event_queue                      *ev_q;
60 };
61
62 #define PTHREAD_ONCE_INIT PARLIB_ONCE_INIT
63 #define PTHREAD_BARRIER_SERIAL_THREAD 12345
64 #define PTHREAD_BARRIER_SPINS 100 // totally arbitrary
65 #define PTHREAD_PROCESS_PRIVATE 0
66 #define PTHREAD_PROCESS_SHARED 1
67
68 #define PTHREAD_MUTEX_NORMAL 0
69 #define PTHREAD_MUTEX_RECURSIVE 1
70 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
71 typedef struct {
72         int type;
73 } pthread_mutexattr_t;
74
75 typedef struct {
76         int                                                     type;
77         uth_mutex_t                                     mtx;
78         uth_recurse_mutex_t                     r_mtx;
79 } pthread_mutex_t;
80 #define PTHREAD_MUTEX_INITIALIZER { PTHREAD_MUTEX_DEFAULT, UTH_MUTEX_INIT, \
81                                     UTH_RECURSE_MUTEX_INIT }
82
83 typedef int clockid_t;
84 typedef struct {
85         int                                                     pshared;
86         clockid_t                                       clock;
87 } pthread_condattr_t;
88 #define PTHREAD_COND_INITIALIZER UTH_COND_VAR_INIT
89
90 /* Regarding the spinlock vs MCS, I don't expect this lock to be heavily
91  * contended.  Most of the time, the caller already holds the mutex associated
92  * with the cond var. */
93 typedef uth_cond_var_t pthread_cond_t;
94
95 typedef uth_rwlock_t pthread_rwlock_t;
96 #define PTHREAD_RWLOCK_INITIALIZER UTH_RWLOCK_INIT
97 /* Will try to avoid the rwlockattr_t business for now */
98 typedef void * pthread_rwlockattr_t;
99
100 typedef struct
101 {
102         int                                                     total_threads;
103         volatile int                            sense;  /* state of barrier, flips btw runs */
104         atomic_t                                        count;
105         struct spin_pdr_lock            lock;
106         uth_sync_t                                      waiters;
107         int                                                     nr_waiters;
108 } pthread_barrier_t;
109
110 /* Detach state.  */
111 enum
112 {
113   PTHREAD_CREATE_JOINABLE,
114 #define PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_JOINABLE
115   PTHREAD_CREATE_DETACHED
116 #define PTHREAD_CREATE_DETACHED PTHREAD_CREATE_DETACHED
117 };
118
119 #define PTHREAD_STACK_PAGES 1024
120 #define PTHREAD_STACK_SIZE (PTHREAD_STACK_PAGES*PGSIZE)
121 #define PTHREAD_STACK_MIN PTHREAD_STACK_SIZE
122
123 typedef struct 
124 {
125         void *stackaddr;
126         size_t stacksize;
127         size_t guardsize;
128         int detachstate;
129         int sched_priority;
130         int sched_policy;
131         int sched_inherit;
132 } pthread_attr_t;
133 typedef int pthread_barrierattr_t;
134 typedef parlib_once_t pthread_once_t;
135 typedef dtls_key_t pthread_key_t;
136
137 /* Akaros pthread extensions / hacks */
138 void pthread_need_tls(bool need);                       /* default is TRUE */
139 void pthread_lib_init(void);
140 void pthread_mcp_init(void);
141 void __pthread_generic_yield(struct pthread_tcb *pthread);
142
143 /* Profiling alarms for pthreads.  (profalarm.c) */
144 void enable_profalarm(uint64_t usecs);
145 void disable_profalarm(void);
146
147 /* The pthreads API */
148 int pthread_attr_init(pthread_attr_t *);
149 int pthread_attr_destroy(pthread_attr_t *);
150 int __pthread_create(pthread_t *, const pthread_attr_t *,
151                      void *(*)(void *), void *);
152 int pthread_create(pthread_t *, const pthread_attr_t *,
153                    void *(*)(void *), void *);
154 int pthread_detach(pthread_t __th);
155 int pthread_join(pthread_t, void **);
156 int pthread_yield(void);
157
158 int pthread_attr_setdetachstate(pthread_attr_t *__attr,int __detachstate);
159 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
160 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize);
161 int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize);
162 int pthread_attr_getguardsize(pthread_attr_t *attr, size_t *guardsize);
163
164 int pthread_mutex_destroy(pthread_mutex_t *);
165 int pthread_mutex_init(pthread_mutex_t *, const pthread_mutexattr_t *);
166 int pthread_mutex_lock(pthread_mutex_t *);
167 int pthread_mutex_trylock(pthread_mutex_t *);
168 int pthread_mutex_unlock(pthread_mutex_t *);
169 int pthread_mutex_destroy(pthread_mutex_t *);
170
171 int pthread_mutexattr_init(pthread_mutexattr_t *);
172 int pthread_mutexattr_destroy(pthread_mutexattr_t *);
173 int pthread_mutexattr_gettype(const pthread_mutexattr_t *, int *);
174 int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
175
176 int pthread_cond_init(pthread_cond_t *, const pthread_condattr_t *);
177 int pthread_cond_destroy(pthread_cond_t *);
178 int pthread_cond_broadcast(pthread_cond_t *);
179 int pthread_cond_signal(pthread_cond_t *);
180 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
181
182 int pthread_condattr_init(pthread_condattr_t *);
183 int pthread_condattr_destroy(pthread_condattr_t *);
184 int pthread_condattr_getpshared(pthread_condattr_t *, int *);
185 int pthread_condattr_setpshared(pthread_condattr_t *, int);
186 int pthread_condattr_getclock(const pthread_condattr_t *attr,
187                               clockid_t *clock_id);
188 int pthread_condattr_setclock(pthread_condattr_t *attr, clockid_t clock_id);
189
190 int pthread_rwlock_init(pthread_rwlock_t *rwl, const pthread_rwlockattr_t *a);
191 int pthread_rwlock_destroy(pthread_rwlock_t *rwl);
192 int pthread_rwlock_rdlock(pthread_rwlock_t *rwl);
193 int pthread_rwlock_tryrdlock(pthread_rwlock_t *rwl);
194 int pthread_rwlock_wrlock(pthread_rwlock_t *rwl);
195 int pthread_rwlock_trywrlock(pthread_rwlock_t *rwl);
196 int pthread_rwlock_unlock(pthread_rwlock_t *rwl);
197
198 pthread_t pthread_self();
199 int pthread_equal(pthread_t t1, pthread_t t2);
200 void pthread_exit(void* ret);
201 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void));
202
203 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count);
204 int pthread_barrier_wait(pthread_barrier_t* b);
205 int pthread_barrier_destroy(pthread_barrier_t* b);
206
207 // POSIX signal compliance
208 int pthread_kill (pthread_t __threadid, int __signo);
209 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
210 int pthread_sigqueue(pthread_t *thread, int sig, const union sigval value);
211
212 // Dynamic TLS stuff
213 int pthread_key_create(pthread_key_t *key, void (*destructor)(void*));
214 int pthread_key_delete(pthread_key_t key);
215 void *pthread_getspecific(pthread_key_t key);
216 int pthread_setspecific(pthread_key_t key, const void *value);
217
218 /* Common stuff. */
219 int pthread_equal(pthread_t __thread1, pthread_t __thread2);
220 int pthread_getattr_np(pthread_t __th, pthread_attr_t *__attr);
221 int pthread_attr_getstack(const pthread_attr_t *__attr,
222                            void **__stackaddr, size_t *__stacksize);
223 int pthread_cancel(pthread_t __th);
224 void pthread_cleanup_push(void (*routine)(void *), void *arg);
225 void pthread_cleanup_pop(int execute);
226
227 /* Scheduling Stuff, mostly ignored by the actual 2LS */
228 int pthread_attr_setschedparam(pthread_attr_t *attr,
229                                const struct sched_param *param);
230 int pthread_attr_getschedparam(pthread_attr_t *attr,
231                                struct sched_param *param);
232 /* Policies are from sched.h. */
233 int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
234 int pthread_attr_getschedpolicy(pthread_attr_t *attr, int *policy);
235
236 #define PTHREAD_SCOPE_SYSTEM    1
237 #define PTHREAD_SCOPE_PROCESS   2
238 int pthread_attr_setscope(pthread_attr_t *attr, int scope);
239 int pthread_attr_getscope(pthread_attr_t *attr, int *scope);
240
241 #define PTHREAD_INHERIT_SCHED   1
242 #define PTHREAD_EXPLICIT_SCHED  2
243 int pthread_attr_setinheritsched(pthread_attr_t *attr,
244                                  int inheritsched);
245 int pthread_attr_getinheritsched(const pthread_attr_t *attr,
246                                  int *inheritsched);
247
248 int pthread_setschedparam(pthread_t thread, int policy,
249                           const struct sched_param *param);
250 int pthread_getschedparam(pthread_t thread, int *policy,
251                           struct sched_param *param);
252
253 /* Unsupported Stuff */
254 extern int pthread_mutex_timedlock (pthread_mutex_t *__restrict __mutex,
255                     const struct timespec *__restrict
256                     __abstime) __THROWNL __nonnull ((1, 2));
257 extern int pthread_cond_timedwait (pthread_cond_t *__restrict __cond,
258                    pthread_mutex_t *__restrict __mutex,
259                    const struct timespec *__restrict __abstime)
260      __nonnull ((1, 2, 3));
261
262 __END_DECLS