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