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