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