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