Pthread state tracking
[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 *join_target;        /* only used to communicate with yield*/
32         struct pthread_tcb *joiner;                     /* raced on by exit and join */
33         uint32_t id;
34         uint32_t stacksize;
35         void *stacktop;
36         void *(*start_routine)(void*);
37         void *arg;
38         void *retval;
39 };
40 typedef struct pthread_tcb* pthread_t;
41 TAILQ_HEAD(pthread_queue, pthread_tcb);
42
43 /* Per-vcore data structures to manage syscalls.  The ev_q is where we tell the
44  * kernel to signal us.  We don't need a lock since this is per-vcore and
45  * accessed in vcore context. */
46 struct sysc_mgmt {
47         struct event_queue                      *ev_q;
48 };
49
50 #define PTHREAD_ONCE_INIT 0
51 #define PTHREAD_BARRIER_SERIAL_THREAD 12345
52 #define PTHREAD_MUTEX_INITIALIZER {0}
53 #define PTHREAD_MUTEX_NORMAL 0
54 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
55 #define PTHREAD_MUTEX_SPINS 100 // totally arbitrary
56 #define PTHREAD_BARRIER_SPINS 100 // totally arbitrary
57 #define PTHREAD_COND_INITIALIZER {0}
58 #define PTHREAD_PROCESS_PRIVATE 0
59
60 typedef struct
61 {
62   int type;
63 } pthread_mutexattr_t;
64
65 typedef struct
66 {
67   const pthread_mutexattr_t* attr;
68   atomic_t lock;
69 } pthread_mutex_t;
70
71 /* TODO: MAX_PTHREADS is arbitrarily defined for now.
72  * It indicates the maximum number of threads that can wait on  
73    the same cond var/ barrier concurrently. */
74
75 #define MAX_PTHREADS 32
76 typedef struct
77 {
78   volatile int sense;
79   int count;
80   int nprocs;
81   pthread_mutex_t pmutex;
82 } pthread_barrier_t;
83
84 #define WAITER_CLEARED 0
85 #define WAITER_WAITING 1
86 #define SLOT_FREE 0
87 #define SLOT_IN_USE 1
88
89 /* Detach state.  */
90 enum
91 {
92   PTHREAD_CREATE_JOINABLE,
93 #define PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_JOINABLE
94   PTHREAD_CREATE_DETACHED
95 #define PTHREAD_CREATE_DETACHED PTHREAD_CREATE_DETACHED
96 };
97
98 // TODO: how big do we want these?  ideally, we want to be able to guard and map
99 // more space if we go too far.
100 #define PTHREAD_STACK_PAGES 4
101 #define PTHREAD_STACK_SIZE (PTHREAD_STACK_PAGES*PGSIZE)
102
103 typedef struct
104 {
105   int pshared;
106 } pthread_condattr_t;
107
108
109 typedef struct
110 {
111   const pthread_condattr_t* attr;
112   uint32_t waiters[MAX_PTHREADS];
113   uint32_t in_use[MAX_PTHREADS];
114   uint32_t next_waiter; //start the search for an available waiter at this spot
115 } pthread_cond_t;
116 typedef struct 
117 {
118         size_t stacksize;
119         int detachstate;
120 } pthread_attr_t;
121 typedef int pthread_barrierattr_t;
122 typedef int pthread_once_t;
123 typedef void** pthread_key_t;
124
125 /* The pthreads API */
126 int pthread_attr_init(pthread_attr_t *);
127 int pthread_attr_destroy(pthread_attr_t *);
128 int pthread_create(pthread_t *, const pthread_attr_t *,
129                    void *(*)(void *), void *);
130 int pthread_join(pthread_t, void **);
131 int pthread_yield(void);
132
133 int pthread_attr_setdetachstate(pthread_attr_t *__attr,int __detachstate);
134
135 int pthread_mutex_destroy(pthread_mutex_t *);
136 int pthread_mutex_init(pthread_mutex_t *, const pthread_mutexattr_t *);
137 int pthread_mutex_lock(pthread_mutex_t *);
138 int pthread_mutex_trylock(pthread_mutex_t *);
139 int pthread_mutex_unlock(pthread_mutex_t *);
140 int pthread_mutex_destroy(pthread_mutex_t *);
141
142 int pthread_mutexattr_init(pthread_mutexattr_t *);
143 int pthread_mutexattr_destroy(pthread_mutexattr_t *);
144 int pthread_mutexattr_gettype(const pthread_mutexattr_t *, int *);
145 int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
146
147 int pthread_cond_init(pthread_cond_t *, const pthread_condattr_t *);
148 int pthread_cond_destroy(pthread_cond_t *);
149 int pthread_cond_broadcast(pthread_cond_t *);
150 int pthread_cond_signal(pthread_cond_t *);
151 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
152
153 int pthread_condattr_init(pthread_condattr_t *);
154 int pthread_condattr_destroy(pthread_condattr_t *);
155 int pthread_condattr_setpshared(pthread_condattr_t *, int);
156 int pthread_condattr_getpshared(pthread_condattr_t *, int *);
157
158 #define pthread_rwlock_t pthread_mutex_t
159 #define pthread_rwlockattr_t pthread_mutexattr_t
160 #define pthread_rwlock_destroy pthread_mutex_destroy
161 #define pthread_rwlock_init pthread_mutex_init
162 #define pthread_rwlock_unlock pthread_mutex_unlock
163 #define pthread_rwlock_rdlock pthread_mutex_lock
164 #define pthread_rwlock_wrlock pthread_mutex_lock
165 #define pthread_rwlock_tryrdlock pthread_mutex_trylock
166 #define pthread_rwlock_trywrlock pthread_mutex_trylock
167
168 pthread_t pthread_self();
169 int pthread_equal(pthread_t t1, pthread_t t2);
170 void pthread_exit(void* ret);
171 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void));
172
173 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count);
174 int pthread_barrier_wait(pthread_barrier_t* b);
175 int pthread_barrier_destroy(pthread_barrier_t* b);
176
177 //added for redis compile
178 int pthread_detach(pthread_t __th);
179 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
180 int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize);
181
182 #ifdef __cplusplus
183   }
184 #endif
185
186 #endif