Pthreads has safe synchronization using yields
[akaros.git] / user / include / 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 /* Our internal types for pthread management */
13 struct pthread_tcb {
14         TAILQ_ENTRY(pthread_tcb) next;
15         void* (*start_routine)(void*);
16         void* arg;
17
18         struct user_trapframe utf;
19         struct ancillary_state as;
20         void *tls_desc;
21         void *stacktop;
22         uint32_t id;
23
24         int finished;
25         void *retval;
26         int detached;
27         // whether or not the scheduler can migrate you from your vcore
28         // will be slightly difficult to see this when given just a vcoreid and
29         // notif_tf ptr
30         bool dont_migrate;
31 };
32 typedef struct pthread_tcb* pthread_t;
33 TAILQ_HEAD(pthread_queue, pthread_tcb);
34
35 /* For compatibility with the existing pthread library */
36 enum
37 {
38   PTHREAD_CREATE_JOINABLE,
39 #define PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_JOINABLE
40   PTHREAD_CREATE_DETACHED
41 #define PTHREAD_CREATE_DETACHED PTHREAD_CREATE_DETACHED
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   int lock;
63 } pthread_mutex_t;
64
65 typedef struct
66 {
67   int local_sense[32*MAX_VCORES];
68   volatile int sense;
69   int count;
70   int nprocs;
71   pthread_mutex_t pmutex;
72 } pthread_barrier_t;
73
74 typedef struct
75 {
76   int pshared;
77 } pthread_condattr_t;
78
79 typedef struct
80 {
81   const pthread_condattr_t* attr;
82   int waiters[MAX_VCORES];
83 } pthread_cond_t;
84
85 typedef int pthread_attr_t;
86 typedef int pthread_barrierattr_t;
87 typedef int pthread_once_t;
88 typedef void** pthread_key_t;
89
90 /* The pthreads API */
91 int pthread_attr_init(pthread_attr_t *);
92 int pthread_attr_destroy(pthread_attr_t *);
93 int pthread_create(pthread_t *, const pthread_attr_t *,
94                    void *(*)(void *), void *);
95 int pthread_join(pthread_t, void **);
96 int pthread_yield(void);
97
98 int pthread_attr_setdetachstate(pthread_attr_t *__attr,int __detachstate);
99
100 int pthread_mutex_destroy(pthread_mutex_t *);
101 int pthread_mutex_init(pthread_mutex_t *, const pthread_mutexattr_t *);
102 int pthread_mutex_lock(pthread_mutex_t *);
103 int pthread_mutex_trylock(pthread_mutex_t *);
104 int pthread_mutex_unlock(pthread_mutex_t *);
105 int pthread_mutex_destroy(pthread_mutex_t *);
106
107 int pthread_mutexattr_init(pthread_mutexattr_t *);
108 int pthread_mutexattr_destroy(pthread_mutexattr_t *);
109 int pthread_mutexattr_gettype(const pthread_mutexattr_t *, int *);
110 int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
111
112 int pthread_cond_init(pthread_cond_t *, const pthread_condattr_t *);
113 int pthread_cond_destroy(pthread_cond_t *);
114 int pthread_cond_broadcast(pthread_cond_t *);
115 int pthread_cond_signal(pthread_cond_t *);
116 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
117
118 int pthread_condattr_init(pthread_condattr_t *);
119 int pthread_condattr_destroy(pthread_condattr_t *);
120 int pthread_condattr_setpshared(pthread_condattr_t *, int);
121 int pthread_condattr_getpshared(pthread_condattr_t *, int *);
122
123 #define pthread_rwlock_t pthread_mutex_t
124 #define pthread_rwlockattr_t pthread_mutexattr_t
125 #define pthread_rwlock_destroy pthread_mutex_destroy
126 #define pthread_rwlock_init pthread_mutex_init
127 #define pthread_rwlock_unlock pthread_mutex_unlock
128 #define pthread_rwlock_rdlock pthread_mutex_lock
129 #define pthread_rwlock_wrlock pthread_mutex_lock
130 #define pthread_rwlock_tryrdlock pthread_mutex_trylock
131 #define pthread_rwlock_trywrlock pthread_mutex_trylock
132
133 pthread_t pthread_self();
134 int pthread_equal(pthread_t t1, pthread_t t2);
135 void pthread_exit(void* ret);
136 int pthread_once(pthread_once_t* once_control, void (*init_routine)(void));
137
138 int pthread_barrier_init(pthread_barrier_t* b, const pthread_barrierattr_t* a, int count);
139 int pthread_barrier_wait(pthread_barrier_t* b);
140 int pthread_barrier_destroy(pthread_barrier_t* b);
141
142 #ifdef __cplusplus
143   }
144 #endif
145
146 #endif