Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
pthread.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2017 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_POSIX_PTHREAD_H_
8#define ZEPHYR_INCLUDE_POSIX_PTHREAD_H_
9
10#include <stdlib.h>
11#include <string.h>
12
13#include <zephyr/kernel.h>
14#include <zephyr/posix/time.h>
15#include <zephyr/posix/unistd.h>
16#include <zephyr/posix/sched.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22/*
23 * Pthread detach/joinable
24 * Undefine possibly predefined values by external toolchain headers
25 */
26#undef PTHREAD_CREATE_DETACHED
27#define PTHREAD_CREATE_DETACHED 1
28#undef PTHREAD_CREATE_JOINABLE
29#define PTHREAD_CREATE_JOINABLE 0
30
31/* Pthread resource visibility */
32#define PTHREAD_PROCESS_PRIVATE 0
33#define PTHREAD_PROCESS_SHARED 1
34
35/* Pthread cancellation */
36#define PTHREAD_CANCELED ((void *)-1)
37#define PTHREAD_CANCEL_ENABLE 0
38#define PTHREAD_CANCEL_DISABLE 1
39#define PTHREAD_CANCEL_DEFERRED 0
40#define PTHREAD_CANCEL_ASYNCHRONOUS 1
41
42/* Pthread scope */
43#undef PTHREAD_SCOPE_PROCESS
44#define PTHREAD_SCOPE_PROCESS 1
45#undef PTHREAD_SCOPE_SYSTEM
46#define PTHREAD_SCOPE_SYSTEM 0
47
48/* Pthread inherit scheduler */
49#undef PTHREAD_INHERIT_SCHED
50#define PTHREAD_INHERIT_SCHED 0
51#undef PTHREAD_EXPLICIT_SCHED
52#define PTHREAD_EXPLICIT_SCHED 1
53
54/* Passed to pthread_once */
55#define PTHREAD_ONCE_INIT {0}
56
57/* The minimum allowable stack size */
58#define PTHREAD_STACK_MIN K_KERNEL_STACK_LEN(0)
59
65#define PTHREAD_COND_INITIALIZER (-1)
66
72int pthread_cond_init(pthread_cond_t *cv, const pthread_condattr_t *att);
73
80
87
94
101
108 const struct timespec *abstime);
109
116int pthread_condattr_init(pthread_condattr_t *att);
117
124int pthread_condattr_destroy(pthread_condattr_t *att);
125
132int pthread_condattr_getclock(const pthread_condattr_t *ZRESTRICT att,
133 clockid_t *ZRESTRICT clock_id);
134
142int pthread_condattr_setclock(pthread_condattr_t *att, clockid_t clock_id);
143
149#define PTHREAD_MUTEX_INITIALIZER (-1)
150
156#define PTHREAD_RWLOCK_INITIALIZER (-1)
157
158/*
159 * Mutex attributes - type
160 *
161 * PTHREAD_MUTEX_NORMAL: Owner of mutex cannot relock it. Attempting
162 * to relock will cause deadlock.
163 * PTHREAD_MUTEX_RECURSIVE: Owner can relock the mutex.
164 * PTHREAD_MUTEX_ERRORCHECK: If owner attempts to relock the mutex, an
165 * error is returned.
166 *
167 */
168#define PTHREAD_MUTEX_NORMAL 0
169#define PTHREAD_MUTEX_RECURSIVE 1
170#define PTHREAD_MUTEX_ERRORCHECK 2
171#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
172
173/*
174 * Mutex attributes - protocol
175 *
176 * PTHREAD_PRIO_NONE: Ownership of mutex does not affect priority.
177 * PTHREAD_PRIO_INHERIT: Owner's priority is boosted to the priority of
178 * highest priority thread blocked on the mutex.
179 * PTHREAD_PRIO_PROTECT: Mutex has a priority ceiling. The owner's
180 * priority is boosted to the highest priority ceiling of all mutexes
181 * owned (regardless of whether or not other threads are blocked on
182 * any of these mutexes).
183 * FIXME: Only PRIO_NONE is supported. Implement other protocols.
184 */
185#define PTHREAD_PRIO_NONE 0
186
193
200
207
215 const struct timespec *abstime);
216
223
230 const pthread_mutexattr_t *att);
231
237int pthread_mutexattr_setprotocol(pthread_mutexattr_t *attr, int protocol);
238
244int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type);
245
251int pthread_mutexattr_getprotocol(const pthread_mutexattr_t *attr,
252 int *protocol);
253
259int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type);
260
268int pthread_mutexattr_init(pthread_mutexattr_t *attr);
269
277int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
278
279#define PTHREAD_BARRIER_SERIAL_THREAD 1
280
281/*
282 * Barrier attributes - type
283 */
284#define PTHREAD_PROCESS_PRIVATE 0
285#define PTHREAD_PROCESS_PUBLIC 1
286
293
300 unsigned int count);
301
308
315
322
329
336 int *ZRESTRICT pshared);
337
338/* Predicates and setters for various pthread attribute values that we
339 * don't support (or always support: the "process shared" attribute
340 * can only be true given the way Zephyr implements these
341 * objects). Leave these undefined for simplicity instead of defining
342 * stubs to return an error that would have to be logged and
343 * interpreted just to figure out that we didn't support it in the
344 * first place. These APIs are very rarely used even in production
345 * Unix code. Leave the declarations here so they can be easily
346 * uncommented and implemented as needed.
347
348int pthread_condattr_getpshared(const pthread_condattr_t * int *);
349int pthread_condattr_setpshared(pthread_condattr_t *, int);
350int pthread_mutex_consistent(pthread_mutex_t *);
351int pthread_mutex_getprioceiling(const pthread_mutex_t * int *);
352int pthread_mutex_setprioceiling(pthread_mutex_t *, int int *);
353int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *, int *);
354int pthread_mutexattr_getpshared(const pthread_mutexattr_t * int *);
355int pthread_mutexattr_getrobust(const pthread_mutexattr_t * int *);
356int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
357int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
358int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int);
359*/
360
361/* Base Pthread related APIs */
362
372
379
386
393
395 int *ZRESTRICT pshared);
397
398int pthread_attr_getguardsize(const pthread_attr_t *ZRESTRICT attr, size_t *ZRESTRICT guardsize);
399int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize);
400int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize);
401int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
402int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
403int pthread_attr_getschedpolicy(const pthread_attr_t *attr, int *policy);
404int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);
405int pthread_attr_getdetachstate(const pthread_attr_t *attr, int *detachstate);
406int pthread_attr_init(pthread_attr_t *attr);
407int pthread_attr_destroy(pthread_attr_t *attr);
408int pthread_attr_getschedparam(const pthread_attr_t *attr,
409 struct sched_param *schedparam);
410int pthread_getschedparam(pthread_t pthread, int *policy,
411 struct sched_param *param);
412int pthread_attr_getstack(const pthread_attr_t *attr,
413 void **stackaddr, size_t *stacksize);
414int pthread_attr_setstack(pthread_attr_t *attr, void *stackaddr,
415 size_t stacksize);
416int pthread_attr_getscope(const pthread_attr_t *attr, int *contentionscope);
417int pthread_attr_setscope(pthread_attr_t *attr, int contentionscope);
418int pthread_attr_getinheritsched(const pthread_attr_t *attr, int *inheritsched);
419int pthread_attr_setinheritsched(pthread_attr_t *attr, int inheritsched);
420#ifdef CONFIG_PTHREAD_IPC
421int pthread_once(pthread_once_t *once, void (*initFunc)(void));
422#endif
423FUNC_NORETURN void pthread_exit(void *retval);
424int pthread_join(pthread_t thread, void **status);
427int pthread_create(pthread_t *newthread, const pthread_attr_t *attr,
428 void *(*threadroutine)(void *), void *arg);
429int pthread_setcancelstate(int state, int *oldstate);
430int pthread_setcanceltype(int type, int *oldtype);
432int pthread_attr_setschedparam(pthread_attr_t *attr,
433 const struct sched_param *schedparam);
434int pthread_setschedparam(pthread_t pthread, int policy,
435 const struct sched_param *param);
436int pthread_setschedprio(pthread_t thread, int prio);
439 const pthread_rwlockattr_t *attr);
442 const struct timespec *abstime);
444 const struct timespec *abstime);
449int pthread_key_create(pthread_key_t *key,
450 void (*destructor)(void *));
451int pthread_key_delete(pthread_key_t key);
452int pthread_setspecific(pthread_key_t key, const void *value);
453void *pthread_getspecific(pthread_key_t key);
454int pthread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));
456int pthread_setconcurrency(int new_level);
457
458void __z_pthread_cleanup_push(void *cleanup[3], void (*routine)(void *arg), void *arg);
459void __z_pthread_cleanup_pop(int execute);
460
461#define pthread_cleanup_push(_rtn, _arg) \
462 do /* enforce '{'-like behaviour */ { \
463 void *_z_pthread_cleanup[3]; \
464 __z_pthread_cleanup_push(_z_pthread_cleanup, _rtn, _arg)
465
466#define pthread_cleanup_pop(_ex) \
467 __z_pthread_cleanup_pop(_ex); \
468 } /* enforce '}'-like behaviour */ while (0)
469
470/* Glibc / Oracle Extension Functions */
471
486int pthread_setname_np(pthread_t thread, const char *name);
487
503int pthread_getname_np(pthread_t thread, char *name, size_t len);
504
505#ifdef CONFIG_PTHREAD_IPC
506
512int pthread_spin_destroy(pthread_spinlock_t *lock);
513
519int pthread_spin_init(pthread_spinlock_t *lock, int pshared);
520
526int pthread_spin_lock(pthread_spinlock_t *lock);
527
533int pthread_spin_trylock(pthread_spinlock_t *lock);
534
540int pthread_spin_unlock(pthread_spinlock_t *lock);
541
542#endif
543
544#ifdef __cplusplus
545}
546#endif
547
548#endif /* ZEPHYR_INCLUDE_POSIX_PTHREAD_H_ */
#define ZRESTRICT
Definition: common.h:36
Public kernel APIs.
state
Definition: parser_state.h:29
uint32_t pthread_cond_t
Definition: posix_types.h:73
uint32_t pthread_spinlock_t
Definition: posix_types.h:54
uint32_t pthread_t
Definition: posix_types.h:53
uint32_t pthread_mutex_t
Definition: posix_types.h:60
uint32_t pthread_rwlockattr_t
Definition: posix_types.h:92
uint32_t clockid_t
Definition: posix_types.h:33
uint32_t pthread_rwlock_t
Definition: posix_types.h:94
uint32_t pthread_barrier_t
Definition: posix_types.h:86
int pthread_condattr_init(pthread_condattr_t *att)
POSIX threading compatibility API.
int pthread_mutex_unlock(pthread_mutex_t *m)
POSIX threading compatibility API.
int pthread_rwlock_trywrlock(pthread_rwlock_t *rwlock)
int pthread_attr_init(pthread_attr_t *attr)
int pthread_rwlock_init(pthread_rwlock_t *rwlock, const pthread_rwlockattr_t *attr)
int pthread_rwlock_timedwrlock(pthread_rwlock_t *rwlock, const struct timespec *abstime)
int pthread_attr_setschedparam(pthread_attr_t *attr, const struct sched_param *schedparam)
int pthread_mutexattr_getprotocol(const pthread_mutexattr_t *attr, int *protocol)
POSIX threading compatibility API.
int pthread_setspecific(pthread_key_t key, const void *value)
int pthread_mutexattr_destroy(pthread_mutexattr_t *attr)
POSIX threading compatibility API.
int pthread_equal(pthread_t pt1, pthread_t pt2)
Compare thread IDs.
int pthread_cond_init(pthread_cond_t *cv, const pthread_condattr_t *att)
POSIX threading compatibility API.
int pthread_setcancelstate(int state, int *oldstate)
int pthread_attr_getdetachstate(const pthread_attr_t *attr, int *detachstate)
int pthread_setconcurrency(int new_level)
int pthread_attr_destroy(pthread_attr_t *attr)
pthread_t pthread_self(void)
Obtain ID of the calling thread.
int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize)
int pthread_barrierattr_getpshared(const pthread_barrierattr_t *ZRESTRICT attr, int *ZRESTRICT pshared)
POSIX threading compatibility API.
int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *ZRESTRICT attr, int *ZRESTRICT pshared)
int pthread_rwlock_wrlock(pthread_rwlock_t *rwlock)
int pthread_barrierattr_destroy(pthread_barrierattr_t *b)
POSIX threading compatibility API.
int pthread_cond_wait(pthread_cond_t *cv, pthread_mutex_t *mut)
POSIX threading compatibility API.
int pthread_cancel(pthread_t pthread)
int pthread_attr_setscope(pthread_attr_t *attr, int contentionscope)
int pthread_join(pthread_t thread, void **status)
int pthread_condattr_getclock(const pthread_condattr_t *ZRESTRICT att, clockid_t *ZRESTRICT clock_id)
POSIX threading comatibility API.
int pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr)
Destroy the read-write lock attributes object.
int pthread_mutex_init(pthread_mutex_t *m, const pthread_mutexattr_t *att)
POSIX threading compatibility API.
int pthread_rwlock_destroy(pthread_rwlock_t *rwlock)
int pthread_attr_getinheritsched(const pthread_attr_t *attr, int *inheritsched)
int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy)
int pthread_setschedprio(pthread_t thread, int prio)
int pthread_detach(pthread_t thread)
int pthread_rwlock_unlock(pthread_rwlock_t *rwlock)
int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type)
POSIX threading compatibility API.
int pthread_atfork(void(*prepare)(void), void(*parent)(void), void(*child)(void))
int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type)
POSIX threading compatibility API.
int pthread_cond_destroy(pthread_cond_t *cv)
POSIX threading compatibility API.
int pthread_getname_np(pthread_t thread, char *name, size_t len)
Get name of POSIX thread and store in name buffer that is of size len.
int pthread_cond_broadcast(pthread_cond_t *cv)
POSIX threading compatibility API.
int pthread_attr_setstack(pthread_attr_t *attr, void *stackaddr, size_t stacksize)
int pthread_rwlockattr_init(pthread_rwlockattr_t *attr)
initialize the read-write lock attributes object.
int pthread_setname_np(pthread_t thread, const char *name)
Set name of POSIX thread.
int pthread_barrierattr_setpshared(pthread_barrierattr_t *attr, int pshared)
POSIX threading compatibility API.
int pthread_setcanceltype(int type, int *oldtype)
int pthread_rwlock_tryrdlock(pthread_rwlock_t *rwlock)
int pthread_barrier_destroy(pthread_barrier_t *b)
POSIX threading compatibility API.
FUNC_NORETURN void pthread_exit(void *retval)
int pthread_mutex_timedlock(pthread_mutex_t *m, const struct timespec *abstime)
POSIX threading compatibility API.
int pthread_attr_getschedparam(const pthread_attr_t *attr, struct sched_param *schedparam)
int pthread_attr_getguardsize(const pthread_attr_t *ZRESTRICT attr, size_t *ZRESTRICT guardsize)
int pthread_condattr_setclock(pthread_condattr_t *att, clockid_t clock_id)
POSIX threading compatibility API.
int pthread_getschedparam(pthread_t pthread, int *policy, struct sched_param *param)
int pthread_create(pthread_t *newthread, const pthread_attr_t *attr, void *(*threadroutine)(void *), void *arg)
int pthread_rwlock_rdlock(pthread_rwlock_t *rwlock)
int pthread_mutex_trylock(pthread_mutex_t *m)
POSIX threading compatibility API.
void * pthread_getspecific(pthread_key_t key)
int pthread_attr_getscope(const pthread_attr_t *attr, int *contentionscope)
int pthread_attr_setinheritsched(pthread_attr_t *attr, int inheritsched)
int pthread_barrierattr_init(pthread_barrierattr_t *b)
POSIX threading compatibility API.
int pthread_rwlock_timedrdlock(pthread_rwlock_t *rwlock, const struct timespec *abstime)
int pthread_setschedparam(pthread_t pthread, int policy, const struct sched_param *param)
int pthread_cond_signal(pthread_cond_t *cv)
POSIX threading compatibility API.
int pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *attr, int pshared)
int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate)
int pthread_mutexattr_setprotocol(pthread_mutexattr_t *attr, int protocol)
POSIX threading compatibility API.
int pthread_attr_getstack(const pthread_attr_t *attr, void **stackaddr, size_t *stacksize)
int pthread_barrier_init(pthread_barrier_t *b, const pthread_barrierattr_t *attr, unsigned int count)
POSIX threading compatibility API.
int pthread_cond_timedwait(pthread_cond_t *cv, pthread_mutex_t *mut, const struct timespec *abstime)
POSIX threading compatibility API.
int pthread_key_delete(pthread_key_t key)
int pthread_attr_getschedpolicy(const pthread_attr_t *attr, int *policy)
void pthread_testcancel(void)
int pthread_condattr_destroy(pthread_condattr_t *att)
POSIX threading compatibility API.
int pthread_key_create(pthread_key_t *key, void(*destructor)(void *))
int pthread_barrier_wait(pthread_barrier_t *b)
POSIX threading compatibility API.
int pthread_mutex_destroy(pthread_mutex_t *m)
POSIX threading compatibility API.
int pthread_mutexattr_init(pthread_mutexattr_t *attr)
POSIX threading compatibility API.
int pthread_getconcurrency(void)
int pthread_mutex_lock(pthread_mutex_t *m)
POSIX threading compatibility API.
Definition: posix_types.h:88
Definition: posix_types.h:96
Definition: _timespec.h:22