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