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