1 /*
2 * Copyright (c) 2006-2018, RT-Thread Development Team
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 *
6 * Change Logs:
7 * Date Author Notes
8 * 2010-10-26 Bernard the first version
9 */
10
11 #ifndef __PTHREAD_H__
12 #define __PTHREAD_H__
13
14 #include <rtthread.h>
15
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19
20 #include <posix_types.h>
21 #include <sched.h>
22
23 #define PTHREAD_KEY_MAX 8
24
25 #define PTHREAD_COND_INITIALIZER {-1, 0}
26 #define PTHREAD_RWLOCK_INITIALIZER {-1, 0}
27 #define PTHREAD_MUTEX_INITIALIZER {-1, 0}
28
29 #define PTHREAD_CREATE_JOINABLE 0x00
30 #define PTHREAD_CREATE_DETACHED 0x01
31
32 #define PTHREAD_EXPLICIT_SCHED 0
33 #define PTHREAD_INHERIT_SCHED 1
34
35 typedef rt_thread_t pthread_t;
36 typedef long pthread_condattr_t;
37 typedef long pthread_rwlockattr_t;
38 typedef long pthread_mutexattr_t;
39 typedef long pthread_barrierattr_t;
40
41 typedef int pthread_key_t;
42 typedef int pthread_once_t;
43
44 enum
45 {
46 PTHREAD_CANCEL_ASYNCHRONOUS = 0,
47 PTHREAD_CANCEL_ENABLE,
48 PTHREAD_CANCEL_DEFERRED,
49 PTHREAD_CANCEL_DISABLE,
50 PTHREAD_CANCELED
51 };
52
53 enum
54 {
55 PTHREAD_MUTEX_NORMAL = 0,
56 PTHREAD_MUTEX_RECURSIVE = 1,
57 PTHREAD_MUTEX_ERRORCHECK = 2,
58 PTHREAD_MUTEX_ERRORCHECK_NP = PTHREAD_MUTEX_ERRORCHECK,
59 PTHREAD_MUTEX_RECURSIVE_NP = PTHREAD_MUTEX_RECURSIVE,
60 PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL
61 };
62
63 /* init value for pthread_once_t */
64 #define PTHREAD_ONCE_INIT 0
65
66 enum
67 {
68 PTHREAD_PRIO_INHERIT =0,
69 PTHREAD_PRIO_NONE,
70 PTHREAD_PRIO_PROTECT,
71 };
72
73 #define PTHREAD_PROCESS_PRIVATE 0
74 #define PTHREAD_PROCESS_SHARED 1
75
76 #define PTHREAD_SCOPE_PROCESS 0
77 #define PTHREAD_SCOPE_SYSTEM 1
78
79 struct pthread_attr
80 {
81 void* stack_base;
82 rt_uint32_t stack_size; /* stack size of thread */
83
84 rt_uint8_t priority; /* priority of thread */
85 rt_uint8_t detachstate; /* detach state */
86 rt_uint8_t policy; /* scheduler policy */
87 rt_uint8_t inheritsched; /* Inherit parent prio/policy */
88 };
89 typedef struct pthread_attr pthread_attr_t;
90
91 struct pthread_mutex
92 {
93 pthread_mutexattr_t attr;
94 struct rt_mutex lock;
95 };
96 typedef struct pthread_mutex pthread_mutex_t;
97
98 struct pthread_cond
99 {
100 pthread_condattr_t attr;
101 struct rt_semaphore sem;
102 };
103 typedef struct pthread_cond pthread_cond_t;
104
105 struct pthread_rwlock
106 {
107 pthread_rwlockattr_t attr;
108
109 pthread_mutex_t rw_mutex; /* basic lock on this struct */
110 pthread_cond_t rw_condreaders; /* for reader threads waiting */
111 pthread_cond_t rw_condwriters; /* for writer threads waiting */
112
113 int rw_nwaitreaders; /* the number of reader threads waiting */
114 int rw_nwaitwriters; /* the number of writer threads waiting */
115 int rw_refcount; /* 0: unlocked, -1: locked by writer, > 0 locked by n readers */
116 };
117 typedef struct pthread_rwlock pthread_rwlock_t;
118
119 /* spinlock implementation, (ADVANCED REALTIME THREADS)*/
120 struct pthread_spinlock
121 {
122 int lock;
123 };
124 typedef struct pthread_spinlock pthread_spinlock_t;
125
126 struct pthread_barrier
127 {
128 int count;
129 pthread_cond_t cond;
130 pthread_mutex_t mutex;
131 };
132 typedef struct pthread_barrier pthread_barrier_t;
133
134 struct sched_param
135 {
136 int sched_priority;
137 };
138
139 /* pthread thread interface */
140 int pthread_attr_destroy(pthread_attr_t *attr);
141 int pthread_attr_init(pthread_attr_t *attr);
142 int pthread_attr_setdetachstate(pthread_attr_t *attr, int state);
143 int pthread_attr_getdetachstate(pthread_attr_t const *attr, int *state);
144 int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
145 int pthread_attr_getschedpolicy(pthread_attr_t const *attr, int *policy);
146 int pthread_attr_setschedparam(pthread_attr_t *attr,struct sched_param const *param);
147 int pthread_attr_getschedparam(pthread_attr_t const *attr,struct sched_param *param);
148 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stack_size);
149 int pthread_attr_getstacksize(pthread_attr_t const *attr, size_t *stack_size);
150 int pthread_attr_setstackaddr(pthread_attr_t *attr, void *stack_addr);
151 int pthread_attr_getstackaddr(pthread_attr_t const *attr, void **stack_addr);
152 int pthread_attr_setstack(pthread_attr_t *attr,
153 void *stack_base,
154 size_t stack_size);
155 int pthread_attr_getstack(pthread_attr_t const *attr,
156 void **stack_base,
157 size_t *stack_size);
158 int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guard_size);
159 int pthread_attr_getguardsize(pthread_attr_t const *attr, size_t *guard_size);
160 int pthread_attr_setscope(pthread_attr_t *attr, int scope);
161 int pthread_attr_getscope(pthread_attr_t const *attr);
162 int pthread_system_init(void);
163 int pthread_create (pthread_t *tid, const pthread_attr_t *attr,
164 void *(*start) (void *), void *arg);
165
166 int pthread_detach (pthread_t thread);
167 int pthread_join (pthread_t thread, void **value_ptr);
168
pthread_equal(pthread_t t1,pthread_t t2)169 rt_inline int pthread_equal (pthread_t t1, pthread_t t2)
170 {
171 return t1 == t2;
172 }
173
pthread_self(void)174 rt_inline pthread_t pthread_self (void)
175 {
176 return rt_thread_self();
177 }
178
179 void pthread_exit (void *value_ptr);
180 int pthread_once(pthread_once_t * once_control, void (*init_routine) (void));
181
182 /* pthread cleanup */
183 void pthread_cleanup_pop(int execute);
184 void pthread_cleanup_push(void (*routine)(void*), void *arg);
185
186 /* pthread cancel */
187 int pthread_cancel(pthread_t thread);
188 void pthread_testcancel(void);
189 int pthread_setcancelstate(int state, int *oldstate);
190 int pthread_setcanceltype(int type, int *oldtype);
191
192 int pthread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));
193 int pthread_kill(pthread_t thread, int sig);
194
195 /* pthread mutex interface */
196 int pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr);
197 int pthread_mutex_destroy(pthread_mutex_t *mutex);
198 int pthread_mutex_lock(pthread_mutex_t *mutex);
199 int pthread_mutex_unlock(pthread_mutex_t *mutex);
200 int pthread_mutex_trylock(pthread_mutex_t *mutex);
201
202 int pthread_mutexattr_init(pthread_mutexattr_t *attr);
203 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
204 int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type);
205 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type);
206 int pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int pshared);
207 int pthread_mutexattr_getpshared(pthread_mutexattr_t *attr, int *pshared);
208
209 /* pthread condition interface */
210 int pthread_condattr_destroy(pthread_condattr_t *attr);
211 int pthread_condattr_init(pthread_condattr_t *attr);
212
213 /* ADVANCED REALTIME feature in IEEE Std 1003.1, 2004 Edition */
214 int pthread_condattr_getclock(const pthread_condattr_t *attr,
215 clockid_t *clock_id);
216 int pthread_condattr_setclock(pthread_condattr_t *attr,
217 clockid_t clock_id);
218
219 int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr);
220 int pthread_cond_destroy(pthread_cond_t *cond);
221 int pthread_cond_broadcast(pthread_cond_t *cond);
222 int pthread_cond_signal(pthread_cond_t *cond);
223
224 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
225 int pthread_cond_timedwait(pthread_cond_t *cond,
226 pthread_mutex_t *mutex,
227 const struct timespec *abstime);
228
229 /* pthread rwlock interface */
230 int pthread_rwlockattr_init (pthread_rwlockattr_t *attr);
231 int pthread_rwlockattr_destroy (pthread_rwlockattr_t *attr);
232 int pthread_rwlockattr_getpshared (const pthread_rwlockattr_t *attr, int *pshared);
233 int pthread_rwlockattr_setpshared (pthread_rwlockattr_t *attr, int pshared);
234
235 int pthread_rwlock_init (pthread_rwlock_t *rwlock, const pthread_rwlockattr_t *attr);
236 int pthread_rwlock_destroy (pthread_rwlock_t *rwlock);
237
238 int pthread_rwlock_rdlock (pthread_rwlock_t *rwlock);
239 int pthread_rwlock_tryrdlock (pthread_rwlock_t *rwlock);
240
241 int pthread_rwlock_timedrdlock (pthread_rwlock_t *rwlock, const struct timespec *abstime);
242 int pthread_rwlock_timedwrlock (pthread_rwlock_t *rwlock, const struct timespec *abstime);
243
244 int pthread_rwlock_unlock (pthread_rwlock_t *rwlock);
245
246 int pthread_rwlock_wrlock (pthread_rwlock_t *rwlock);
247 int pthread_rwlock_trywrlock (pthread_rwlock_t *rwlock);
248
249 /* pthread spinlock interface */
250 int pthread_spin_init (pthread_spinlock_t *lock, int pshared);
251 int pthread_spin_destroy (pthread_spinlock_t *lock);
252
253 int pthread_spin_lock (pthread_spinlock_t * lock);
254 int pthread_spin_trylock (pthread_spinlock_t * lock);
255 int pthread_spin_unlock (pthread_spinlock_t * lock);
256
257 /* pthread barrier interface */
258 int pthread_barrierattr_destroy(pthread_barrierattr_t *attr);
259 int pthread_barrierattr_init(pthread_barrierattr_t *attr);
260 int pthread_barrierattr_getpshared(const pthread_barrierattr_t *attr, int *pshared);
261 int pthread_barrierattr_setpshared(pthread_barrierattr_t *attr, int pshared);
262
263 int pthread_barrier_destroy(pthread_barrier_t *barrier);
264 int pthread_barrier_init(pthread_barrier_t *barrier,
265 const pthread_barrierattr_t *attr,
266 unsigned count);
267
268 int pthread_barrier_wait(pthread_barrier_t *barrier);
269
270 #ifdef __cplusplus
271 }
272 #endif
273
274 #endif
275