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