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