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