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