Pthread cleanup stubs
[akaros.git] / user / pthread / pthread.h
1 #ifndef _PTHREAD_H
2 #define _PTHREAD_H
3
4 #include <sys/queue.h>
5 #include <signal.h>
6 #include <vcore.h>
7 #include <uthread.h>
8 #include <mcs.h>
9 #include <dtls.h>
10 #include <spinlock.h>
11 /* GNU / POSIX scheduling crap */
12 #include <sched.h>
13
14 #ifdef __cplusplus
15   extern "C" {
16 #endif
17
18 /* Pthread states.  These are mostly examples for other 2LSs */
19 #define PTH_CREATED                     1
20 #define PTH_RUNNABLE            2
21 #define PTH_RUNNING                     3
22 #define PTH_EXITING                     4
23 #define PTH_BLK_YIELDING        5       /* brief state btw pth_yield and pth_runnable */
24 #define PTH_BLK_JOINING         6       /* joining on a child */
25 #define PTH_BLK_SYSC            7       /* blocked on a syscall */
26 #define PTH_BLK_MUTEX           8       /* blocked externally, possibly on a mutex */
27 #define PTH_BLK_PAUSED          9       /* handed back to us from uthread code */
28
29 /* Pthread struct.  First has to be the uthread struct, which the vcore code
30  * will access directly (as if pthread_tcb is a struct uthread). */
31 struct pthread_tcb;
32 struct pthread_tcb {
33         struct uthread uthread;
34         TAILQ_ENTRY(pthread_tcb) next;
35         int state;
36         bool detached;
37         struct pthread_tcb *joiner;                     /* raced on by exit and join */
38         uint32_t id;
39         uint32_t stacksize;
40         void *stacktop;
41         void *(*start_routine)(void*);
42         void *arg;
43         void *retval;
44         sigset_t sigmask;
45         sigset_t sigpending;
46         struct sigdata *sigdata;
47         int sched_policy;
48         int sched_priority;             /* careful, GNU #defines this to __sched_priority */
49 };
50 typedef struct pthread_tcb* pthread_t;
51 TAILQ_HEAD(pthread_queue, pthread_tcb);
52
53 /* Per-vcore data structures to manage syscalls.  The ev_q is where we tell the
54  * kernel to signal us.  We don't need a lock since this is per-vcore and
55  * accessed in vcore context. */
56 struct sysc_mgmt {
57         struct event_queue                      *ev_q;
58 };
59
60 #define PTHREAD_ONCE_INIT 0
61 #define PTHREAD_BARRIER_SERIAL_THREAD 12345
62 #define PTHREAD_MUTEX_INITIALIZER {0,0}
63 #define PTHREAD_MUTEX_NORMAL 0
64 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
65 #define PTHREAD_MUTEX_SPINS 100 // totally arbitrary
66 #define PTHREAD_BARRIER_SPINS 100 // totally arbitrary
67 #define PTHREAD_COND_INITIALIZER {0,{0},{0},0}
68 #define PTHREAD_PROCESS_PRIVATE 0
69 #define PTHREAD_PROCESS_SHARED 1
70
71 typedef struct
72 {
73   int type;
74 } pthread_mutexattr_t;
75
76 typedef struct
77 {
78   const pthread_mutexattr_t* attr;
79   atomic_t lock;
80 } pthread_mutex_t;
81
82 typedef struct
83 {
84         int                                                     total_threads;
85         volatile int                            sense;  /* state of barrier, flips btw runs */
86         atomic_t                                        count;
87         struct spin_pdr_lock            lock;
88         struct pthread_queue            waiters;
89         int                                                     nr_waiters;
90 } pthread_barrier_t;
91
92 #define WAITER_CLEARED 0
93 #define WAITER_WAITING 1
94 #define SLOT_FREE 0
95 #define SLOT_IN_USE 1
96
97 /* Detach state.  */
98 enum
99 {
100   PTHREAD_CREATE_JOINABLE,
101 #define PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_JOINABLE
102   PTHREAD_CREATE_DETACHED
103 #define PTHREAD_CREATE_DETACHED PTHREAD_CREATE_DETACHED
104 };
105
106 // TODO: how big do we want these?  ideally, we want to be able to guard and map
107 // more space if we go too far.
108 #define PTHREAD_STACK_PAGES 4
109 #define PTHREAD_STACK_SIZE (PTHREAD_STACK_PAGES*PGSIZE)
110 #define PTHREAD_STACK_MIN PTHREAD_STACK_SIZE
111
112 typedef int clockid_t;
113 typedef struct
114 {
115   int pshared;
116   clockid_t clock;
117 } pthread_condattr_t;
118
119 /* Regarding the spinlock vs MCS, I don't expect this lock to be heavily
120  * contended.  Most of the time, the caller already holds the mutex associated
121  * with the cond var. */
122 typedef struct
123 {
124         struct pthread_queue            waiters;
125         struct spin_pdr_lock            spdr_lock;
126         int                                             attr_pshared;
127         int                                             attr_clock;
128 } pthread_cond_t;
129
130 typedef struct 
131 {
132         void *stackaddr;
133         size_t stacksize;
134         int detachstate;
135         int sched_priority;
136         int sched_policy;
137         int sched_inherit;
138 } pthread_attr_t;
139 typedef int pthread_barrierattr_t;
140 typedef int pthread_once_t;
141 typedef dtls_key_t pthread_key_t;
142
143 /* Akaros pthread extensions / hacks */
144 void pthread_can_vcore_request(bool can);       /* default is TRUE */
145 void pthread_need_tls(bool need);                       /* default is TRUE */
146 void pthread_lib_init(void);
147 void __pthread_generic_yield(struct pthread_tcb *pthread);
148
149 /* The pthreads API */
150 int pthread_attr_init(pthread_attr_t *);
151 int pthread_attr_destroy(pthread_attr_t *);
152 int __pthread_create(pthread_t *, const pthread_attr_t *,
153                      void *(*)(void *), void *);
154 int pthread_create(pthread_t *, const pthread_attr_t *,
155                    void *(*)(void *), void *);
156 int pthread_detach(pthread_t __th);
157 int pthread_join(pthread_t, void **);
158 int pthread_yield(void);
159
160 int pthread_attr_setdetachstate(pthread_attr_t *__attr,int __detachstate);
161 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
162 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize);
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 #define pthread_rwlock_t pthread_mutex_t
191 #define pthread_rwlockattr_t pthread_mutexattr_t
192 #define pthread_rwlock_destroy pthread_mutex_destroy
193 #define pthread_rwlock_init pthread_mutex_init
194 #define pthread_rwlock_unlock pthread_mutex_unlock
195 #define pthread_rwlock_rdlock pthread_mutex_lock
196 #define pthread_rwlock_wrlock pthread_mutex_lock
197 #define pthread_rwlock_tryrdlock pthread_mutex_trylock
198 #define pthread_rwlock_trywrlock pthread_mutex_trylock
199
200 pthread_t pthread_self();
201 int pthread_equal(pthread_t t1, pthread_t t2);
202 void pthread_exit(void* ret);
203 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void));
204
205 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count);
206 int pthread_barrier_wait(pthread_barrier_t* b);
207 int pthread_barrier_destroy(pthread_barrier_t* b);
208
209 // POSIX signal compliance
210 int pthread_kill (pthread_t __threadid, int __signo);
211 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
212 int pthread_sigqueue(pthread_t *thread, int sig, const union sigval value);
213
214 // Dynamic TLS stuff
215 int pthread_key_create(pthread_key_t *key, void (*destructor)(void*));
216 int pthread_key_delete(pthread_key_t key);
217 void *pthread_getspecific(pthread_key_t key);
218 int pthread_setspecific(pthread_key_t key, const void *value);
219
220 /* Common stuff. */
221 int pthread_equal(pthread_t __thread1, pthread_t __thread2);
222 int pthread_getattr_np(pthread_t __th, pthread_attr_t *__attr);
223 int pthread_attr_getstack(const pthread_attr_t *__attr,
224                            void **__stackaddr, size_t *__stacksize);
225
226 /* Scheduling Stuff, mostly ignored by the actual 2LS */
227 int pthread_attr_setschedparam(pthread_attr_t *attr,
228                                const struct sched_param *param);
229 int pthread_attr_getschedparam(pthread_attr_t *attr,
230                                struct sched_param *param);
231 /* Policies are from sched.h. */
232 int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
233 int pthread_attr_getschedpolicy(pthread_attr_t *attr, int *policy);
234
235 #define PTHREAD_SCOPE_SYSTEM    1
236 #define PTHREAD_SCOPE_PROCESS   2
237 int pthread_attr_setscope(pthread_attr_t *attr, int scope);
238 int pthread_attr_getscope(pthread_attr_t *attr, int *scope);
239
240 #define PTHREAD_INHERIT_SCHED   1
241 #define PTHREAD_EXPLICIT_SCHED  2
242 int pthread_attr_setinheritsched(pthread_attr_t *attr,
243                                  int inheritsched);
244 int pthread_attr_getinheritsched(const pthread_attr_t *attr,
245                                  int *inheritsched);
246
247 int pthread_setschedparam(pthread_t thread, int policy,
248                           const struct sched_param *param);
249 int pthread_getschedparam(pthread_t thread, int *policy,
250                           struct sched_param *param);
251
252 /* Unsupported Stuff */
253 typedef void *upthread_once_t;
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 extern int pthread_once (pthread_once_t *__once_control,
262              void (*__init_routine) (void)) __nonnull ((1, 2));
263 extern int pthread_cancel (pthread_t __th);
264 void pthread_cleanup_push(void (*routine)(void *), void *arg);
265 void pthread_cleanup_pop(int execute);
266
267 #ifdef __cplusplus
268   }
269 #endif
270
271 #endif