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