1 /*
2 * Copyright (c) 2006-2021, 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}
26 #define PTHREAD_RWLOCK_INITIALIZER {-1}
27 #define PTHREAD_MUTEX_INITIALIZER {-1}
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 long 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 sched_param
80 {
81 int sched_priority;
82 };
83
84 struct pthread_attr
85 {
86 void* stackaddr; /* stack address of thread */
87 int stacksize; /* stack size of thread */
88
89 int inheritsched; /* Inherit parent prio/policy */
90 int schedpolicy; /* scheduler policy */
91 struct sched_param schedparam; /* sched parameter */
92
93 int detachstate; /* detach state */
94 };
95 typedef struct pthread_attr pthread_attr_t;
96
97 struct pthread_mutex
98 {
99 pthread_mutexattr_t attr;
100 struct rt_mutex lock;
101 };
102 typedef struct pthread_mutex pthread_mutex_t;
103
104 struct pthread_cond
105 {
106 pthread_condattr_t attr;
107 struct rt_semaphore sem;
108 };
109 typedef struct pthread_cond pthread_cond_t;
110
111 struct pthread_rwlock
112 {
113 pthread_rwlockattr_t attr;
114
115 pthread_mutex_t rw_mutex; /* basic lock on this struct */
116 pthread_cond_t rw_condreaders; /* for reader threads waiting */
117 pthread_cond_t rw_condwriters; /* for writer threads waiting */
118
119 int rw_nwaitreaders; /* the number of reader threads waiting */
120 int rw_nwaitwriters; /* the number of writer threads waiting */
121 int rw_refcount; /* 0: unlocked, -1: locked by writer, > 0 locked by n readers */
122 };
123 typedef struct pthread_rwlock pthread_rwlock_t;
124
125 /* spinlock implementation, (ADVANCED REALTIME THREADS)*/
126 struct pthread_spinlock
127 {
128 int lock;
129 };
130 typedef struct pthread_spinlock pthread_spinlock_t;
131
132 struct pthread_barrier
133 {
134 int count;
135 pthread_cond_t cond;
136 pthread_mutex_t mutex;
137 };
138 typedef struct pthread_barrier pthread_barrier_t;
139
140 /* pthread thread interface */
141 int pthread_attr_destroy(pthread_attr_t *attr);
142 int pthread_attr_init(pthread_attr_t *attr);
143 int pthread_attr_setdetachstate(pthread_attr_t *attr, int state);
144 int pthread_attr_getdetachstate(pthread_attr_t const *attr, int *state);
145 int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
146 int pthread_attr_getschedpolicy(pthread_attr_t const *attr, int *policy);
147 int pthread_attr_setschedparam(pthread_attr_t *attr,struct sched_param const *param);
148 int pthread_attr_getschedparam(pthread_attr_t const *attr,struct sched_param *param);
149 int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stack_size);
150 int pthread_attr_getstacksize(pthread_attr_t const *attr, size_t *stack_size);
151 int pthread_attr_setstackaddr(pthread_attr_t *attr, void *stack_addr);
152 int pthread_attr_getstackaddr(pthread_attr_t const *attr, void **stack_addr);
153 int pthread_attr_setstack(pthread_attr_t *attr,
154 void *stack_base,
155 size_t stack_size);
156 int pthread_attr_getstack(pthread_attr_t const *attr,
157 void **stack_base,
158 size_t *stack_size);
159 int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guard_size);
160 int pthread_attr_getguardsize(pthread_attr_t const *attr, size_t *guard_size);
161 int pthread_attr_setinheritsched(pthread_attr_t *attr, int inheritsched);
162 int pthread_attr_getinheritsched(const pthread_attr_t *attr, int *inheritsched);
163 int pthread_attr_setscope(pthread_attr_t *attr, int scope);
164 int pthread_attr_getscope(pthread_attr_t const *attr, int *scope);
165 int pthread_create (pthread_t *tid, const pthread_attr_t *attr,
166 void *(*start) (void *), void *arg);
167
168 int pthread_detach (pthread_t thread);
169 int pthread_join (pthread_t thread, void **value_ptr);
170
pthread_equal(pthread_t t1,pthread_t t2)171 rt_inline int pthread_equal (pthread_t t1, pthread_t t2)
172 {
173 return t1 == t2;
174 }
175
176 pthread_t pthread_self (void);
177
178 int pthread_getcpuclockid(pthread_t thread, clockid_t *clock_id);
179 int pthread_getconcurrency(void);
180 int pthread_setconcurrency(int new_level);
181 int pthread_getschedparam(pthread_t thread, int *policy, struct sched_param *param);
182 int pthread_setschedparam(pthread_t thread, int policy, const struct sched_param *param);
183 int pthread_setschedprio(pthread_t thread, int prio);
184
185 void pthread_exit (void *value_ptr);
186 int pthread_once(pthread_once_t * once_control, void (*init_routine) (void));
187
188 #ifdef RT_USING_SIGNALS
189 int pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
190 #endif
191
192 /* pthread cleanup */
193 void pthread_cleanup_pop(int execute);
194 void pthread_cleanup_push(void (*routine)(void*), void *arg);
195
196 /* pthread cancel */
197 int pthread_cancel(pthread_t thread);
198 void pthread_testcancel(void);
199 int pthread_setcancelstate(int state, int *oldstate);
200 int pthread_setcanceltype(int type, int *oldtype);
201
202 int pthread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));
203 int pthread_kill(pthread_t thread, int sig);
204
205 /* pthread mutex interface */
206 int pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr);
207 int pthread_mutex_destroy(pthread_mutex_t *mutex);
208 int pthread_mutex_lock(pthread_mutex_t *mutex);
209 int pthread_mutex_unlock(pthread_mutex_t *mutex);
210 int pthread_mutex_trylock(pthread_mutex_t *mutex);
211 int pthread_mutex_getprioceiling(const pthread_mutex_t *mutex, int *prioceiling);
212 int pthread_mutex_setprioceiling(pthread_mutex_t *mutex, int prioceiling, int *old_ceiling);
213
214 int pthread_mutexattr_init(pthread_mutexattr_t *attr);
215 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
216 int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type);
217 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type);
218 int pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int pshared);
219 int pthread_mutexattr_getpshared(pthread_mutexattr_t *attr, int *pshared);
220 int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *attr, int *prioceiling);
221 int pthread_mutexattr_setprioceiling(const pthread_mutexattr_t *attr, int prioceiling);
222 int pthread_mutexattr_getprotocol(const pthread_mutexattr_t *attr, int *protocol);
223 int pthread_mutexattr_setprotocol(const pthread_mutexattr_t *attr, int protocol);
224
225
226 /* pthread condition interface */
227 int pthread_condattr_destroy(pthread_condattr_t *attr);
228 int pthread_condattr_init(pthread_condattr_t *attr);
229
230 /* ADVANCED REALTIME feature in IEEE Std 1003.1, 2004 Edition */
231 int pthread_condattr_getclock(const pthread_condattr_t *attr,
232 clockid_t *clock_id);
233 int pthread_condattr_setclock(pthread_condattr_t *attr,
234 clockid_t clock_id);
235
236 int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr);
237 int pthread_cond_destroy(pthread_cond_t *cond);
238 int pthread_cond_broadcast(pthread_cond_t *cond);
239 int pthread_cond_signal(pthread_cond_t *cond);
240
241 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
242 int pthread_cond_timedwait(pthread_cond_t *cond,
243 pthread_mutex_t *mutex,
244 const struct timespec *abstime);
245
246 /* pthread rwlock interface */
247 int pthread_rwlockattr_init (pthread_rwlockattr_t *attr);
248 int pthread_rwlockattr_destroy (pthread_rwlockattr_t *attr);
249 int pthread_rwlockattr_getpshared (const pthread_rwlockattr_t *attr, int *pshared);
250 int pthread_rwlockattr_setpshared (pthread_rwlockattr_t *attr, int pshared);
251
252 int pthread_rwlock_init (pthread_rwlock_t *rwlock, const pthread_rwlockattr_t *attr);
253 int pthread_rwlock_destroy (pthread_rwlock_t *rwlock);
254
255 int pthread_rwlock_rdlock (pthread_rwlock_t *rwlock);
256 int pthread_rwlock_tryrdlock (pthread_rwlock_t *rwlock);
257
258 int pthread_rwlock_timedrdlock (pthread_rwlock_t *rwlock, const struct timespec *abstime);
259 int pthread_rwlock_timedwrlock (pthread_rwlock_t *rwlock, const struct timespec *abstime);
260
261 int pthread_rwlock_unlock (pthread_rwlock_t *rwlock);
262
263 int pthread_rwlock_wrlock (pthread_rwlock_t *rwlock);
264 int pthread_rwlock_trywrlock (pthread_rwlock_t *rwlock);
265
266 /* pthread spinlock interface */
267 int pthread_spin_init (pthread_spinlock_t *lock, int pshared);
268 int pthread_spin_destroy (pthread_spinlock_t *lock);
269
270 int pthread_spin_lock (pthread_spinlock_t * lock);
271 int pthread_spin_trylock (pthread_spinlock_t * lock);
272 int pthread_spin_unlock (pthread_spinlock_t * lock);
273
274 /* pthread barrier interface */
275 int pthread_barrierattr_destroy(pthread_barrierattr_t *attr);
276 int pthread_barrierattr_init(pthread_barrierattr_t *attr);
277 int pthread_barrierattr_getpshared(const pthread_barrierattr_t *attr, int *pshared);
278 int pthread_barrierattr_setpshared(pthread_barrierattr_t *attr, int pshared);
279
280 int pthread_barrier_destroy(pthread_barrier_t *barrier);
281 int pthread_barrier_init(pthread_barrier_t *barrier,
282 const pthread_barrierattr_t *attr,
283 unsigned count);
284
285 int pthread_barrier_wait(pthread_barrier_t *barrier);
286
287 int pthread_setspecific(pthread_key_t key, const void *value);
288 void *pthread_getspecific(pthread_key_t key);
289 int pthread_key_create(pthread_key_t *key, void (*destructor)(void *));
290 int pthread_key_delete(pthread_key_t key);
291
292 #ifdef __cplusplus
293 }
294 #endif
295
296 #endif
297