Implemented a few more stubs for PTHREAD compliance
[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
10 #ifdef __cplusplus
11   extern "C" {
12 #endif
13
14 /* Pthread states.  These are mostly examples for other 2LSs */
15 #define PTH_CREATED                     1
16 #define PTH_RUNNABLE            2
17 #define PTH_RUNNING                     3
18 #define PTH_EXITING                     4
19 #define PTH_BLK_YIELDING        5       /* brief state btw pth_yield and pth_runnable */
20 #define PTH_BLK_JOINING         6       /* joining on a child */
21 #define PTH_BLK_SYSC            7       /* blocked on a syscall */
22 #define PTH_BLK_MUTEX           8       /* blocked externally, possibly on a mutex */
23 #define PTH_BLK_PAUSED          9       /* handed back to us from uthread code */
24
25 /* Pthread struct.  First has to be the uthread struct, which the vcore code
26  * will access directly (as if pthread_tcb is a struct uthread). */
27 struct pthread_tcb;
28 struct pthread_tcb {
29         struct uthread uthread;
30         TAILQ_ENTRY(pthread_tcb) next;
31         int state;
32         bool detached;
33         struct pthread_tcb *joiner;                     /* raced on by exit and join */
34         uint32_t id;
35         uint32_t stacksize;
36         void *stacktop;
37         void *(*start_routine)(void*);
38         void *arg;
39         void *retval;
40         uint64_t sigmask;
41 };
42 typedef struct pthread_tcb* pthread_t;
43 TAILQ_HEAD(pthread_queue, pthread_tcb);
44
45 /* Per-vcore data structures to manage syscalls.  The ev_q is where we tell the
46  * kernel to signal us.  We don't need a lock since this is per-vcore and
47  * accessed in vcore context. */
48 struct sysc_mgmt {
49         struct event_queue                      *ev_q;
50 };
51
52 #define PTHREAD_ONCE_INIT 0
53 #define PTHREAD_BARRIER_SERIAL_THREAD 12345
54 #define PTHREAD_MUTEX_INITIALIZER {0,0}
55 #define PTHREAD_MUTEX_NORMAL 0
56 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
57 #define PTHREAD_MUTEX_SPINS 100 // totally arbitrary
58 #define PTHREAD_BARRIER_SPINS 100 // totally arbitrary
59 #define PTHREAD_COND_INITIALIZER {0,{0},{0},0}
60 #define PTHREAD_PROCESS_PRIVATE 0
61
62 typedef struct
63 {
64   int type;
65 } pthread_mutexattr_t;
66
67 typedef struct
68 {
69   const pthread_mutexattr_t* attr;
70   atomic_t lock;
71 } pthread_mutex_t;
72
73 /* TODO: MAX_PTHREADS is arbitrarily defined for now.
74  * It indicates the maximum number of threads that can wait on  
75    the same cond var/ barrier concurrently. */
76
77 #define MAX_PTHREADS 32
78 typedef struct
79 {
80   volatile int sense;
81   int count;
82   int nprocs;
83   pthread_mutex_t pmutex;
84 } pthread_barrier_t;
85
86 #define WAITER_CLEARED 0
87 #define WAITER_WAITING 1
88 #define SLOT_FREE 0
89 #define SLOT_IN_USE 1
90
91 /* Detach state.  */
92 enum
93 {
94   PTHREAD_CREATE_JOINABLE,
95 #define PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_JOINABLE
96   PTHREAD_CREATE_DETACHED
97 #define PTHREAD_CREATE_DETACHED PTHREAD_CREATE_DETACHED
98 };
99
100 // TODO: how big do we want these?  ideally, we want to be able to guard and map
101 // more space if we go too far.
102 #define PTHREAD_STACK_PAGES 4
103 #define PTHREAD_STACK_SIZE (PTHREAD_STACK_PAGES*PGSIZE)
104
105 typedef struct
106 {
107   int pshared;
108 } pthread_condattr_t;
109
110
111 typedef struct
112 {
113   const pthread_condattr_t* attr;
114   uint32_t waiters[MAX_PTHREADS];
115   uint32_t in_use[MAX_PTHREADS];
116   uint32_t next_waiter; //start the search for an available waiter at this spot
117 } pthread_cond_t;
118 typedef struct 
119 {
120         size_t stacksize;
121         int detachstate;
122 } pthread_attr_t;
123 typedef int pthread_barrierattr_t;
124 typedef int pthread_once_t;
125 typedef void** pthread_key_t;
126
127 /* Akaros pthread extensions / hacks */
128 void pthread_can_vcore_request(bool can);       /* default is TRUE */
129 int pthread_lib_init(void);
130
131 /* The pthreads API */
132 int pthread_attr_init(pthread_attr_t *);
133 int pthread_attr_destroy(pthread_attr_t *);
134 int pthread_create(pthread_t *, const pthread_attr_t *,
135                    void *(*)(void *), void *);
136 int pthread_detach(pthread_t __th);
137 int pthread_join(pthread_t, void **);
138 int pthread_yield(void);
139
140 int pthread_attr_setdetachstate(pthread_attr_t *__attr,int __detachstate);
141 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
142 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize);
143
144 int pthread_mutex_destroy(pthread_mutex_t *);
145 int pthread_mutex_init(pthread_mutex_t *, const pthread_mutexattr_t *);
146 int pthread_mutex_lock(pthread_mutex_t *);
147 int pthread_mutex_trylock(pthread_mutex_t *);
148 int pthread_mutex_unlock(pthread_mutex_t *);
149 int pthread_mutex_destroy(pthread_mutex_t *);
150
151 int pthread_mutexattr_init(pthread_mutexattr_t *);
152 int pthread_mutexattr_destroy(pthread_mutexattr_t *);
153 int pthread_mutexattr_gettype(const pthread_mutexattr_t *, int *);
154 int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
155
156 int pthread_cond_init(pthread_cond_t *, const pthread_condattr_t *);
157 int pthread_cond_destroy(pthread_cond_t *);
158 int pthread_cond_broadcast(pthread_cond_t *);
159 int pthread_cond_signal(pthread_cond_t *);
160 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
161
162 int pthread_condattr_init(pthread_condattr_t *);
163 int pthread_condattr_destroy(pthread_condattr_t *);
164 int pthread_condattr_setpshared(pthread_condattr_t *, int);
165 int pthread_condattr_getpshared(pthread_condattr_t *, int *);
166
167 #define pthread_rwlock_t pthread_mutex_t
168 #define pthread_rwlockattr_t pthread_mutexattr_t
169 #define pthread_rwlock_destroy pthread_mutex_destroy
170 #define pthread_rwlock_init pthread_mutex_init
171 #define pthread_rwlock_unlock pthread_mutex_unlock
172 #define pthread_rwlock_rdlock pthread_mutex_lock
173 #define pthread_rwlock_wrlock pthread_mutex_lock
174 #define pthread_rwlock_tryrdlock pthread_mutex_trylock
175 #define pthread_rwlock_trywrlock pthread_mutex_trylock
176
177 pthread_t pthread_self();
178 int pthread_equal(pthread_t t1, pthread_t t2);
179 void pthread_exit(void* ret);
180 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void));
181
182 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count);
183 int pthread_barrier_wait(pthread_barrier_t* b);
184 int pthread_barrier_destroy(pthread_barrier_t* b);
185
186 // POSIX signal compliance
187 int pthread_kill (pthread_t __threadid, int __signo);
188 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
189 int pthread_sigqueue(pthread_t *thread, int sig, const union sigval value);
190
191 // Dynamic TLS stuff
192 static inline int pthread_key_create(pthread_key_t *key, void (*destructor)(void*))
193 { return -1; }
194 static inline int pthread_key_delete(pthread_key_t key)
195 { return -1; }
196 static inline void *pthread_getspecific(pthread_key_t key)
197 { return NULL; }
198 static inline int pthread_setspecific(pthread_key_t key, const void *value)
199 { return -1; }
200
201 #ifdef __cplusplus
202   }
203 #endif
204
205 #endif