xref: /aosp_15_r20/bionic/libc/include/bits/threads_inlines.h (revision 8d67ca893c1523eb926b9080dbe4e2ffd2a27ba1)
1 /*
2  * Copyright (C) 2019 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #pragma once
30 
31 #include <sys/cdefs.h>
32 
33 #include <threads.h>
34 
35 #include <errno.h>
36 #include <sched.h>
37 #include <stdlib.h>
38 
39 #if defined(__BIONIC_THREADS_INLINE)
40 
41 __BEGIN_DECLS
42 
__bionic_thrd_error(int __pthread_code)43 static __inline int __bionic_thrd_error(int __pthread_code) {
44   switch (__pthread_code) {
45     case 0: return 0;
46     case ENOMEM: return thrd_nomem;
47     case ETIMEDOUT: return thrd_timedout;
48     case EBUSY: return thrd_busy;
49     default: return thrd_error;
50   }
51 }
52 
call_once(once_flag * _Nonnull __flag,void (* _Nonnull __function)(void))53 __BIONIC_THREADS_INLINE void call_once(once_flag* _Nonnull __flag,
54                                        void (* _Nonnull __function)(void)) {
55   pthread_once(__flag, __function);
56 }
57 
58 
59 
cnd_broadcast(cnd_t * _Nonnull __cnd)60 __BIONIC_THREADS_INLINE int cnd_broadcast(cnd_t* _Nonnull __cnd) {
61   return __bionic_thrd_error(pthread_cond_broadcast(__cnd));
62 }
63 
cnd_destroy(cnd_t * _Nonnull __cnd)64 __BIONIC_THREADS_INLINE void cnd_destroy(cnd_t* _Nonnull __cnd) {
65   pthread_cond_destroy(__cnd);
66 }
67 
cnd_init(cnd_t * _Nonnull __cnd)68 __BIONIC_THREADS_INLINE int cnd_init(cnd_t* _Nonnull __cnd) {
69   return __bionic_thrd_error(pthread_cond_init(__cnd, NULL));
70 }
71 
cnd_signal(cnd_t * _Nonnull __cnd)72 __BIONIC_THREADS_INLINE int cnd_signal(cnd_t* _Nonnull __cnd) {
73   return __bionic_thrd_error(pthread_cond_signal(__cnd));
74 }
75 
cnd_timedwait(cnd_t * _Nonnull __cnd,mtx_t * _Nonnull __mtx,const struct timespec * _Nullable __timeout)76 __BIONIC_THREADS_INLINE int cnd_timedwait(cnd_t* _Nonnull __cnd,
77                                           mtx_t* _Nonnull __mtx,
78                                           const struct timespec* _Nullable __timeout) {
79   return __bionic_thrd_error(pthread_cond_timedwait(__cnd, __mtx, __timeout));
80 }
81 
cnd_wait(cnd_t * _Nonnull __cnd,mtx_t * _Nonnull __mtx)82 __BIONIC_THREADS_INLINE int cnd_wait(cnd_t* _Nonnull __cnd, mtx_t* _Nonnull __mtx) {
83   return __bionic_thrd_error(pthread_cond_wait(__cnd, __mtx));
84 }
85 
86 
87 
mtx_destroy(mtx_t * _Nonnull __mtx)88 __BIONIC_THREADS_INLINE void mtx_destroy(mtx_t* _Nonnull __mtx) {
89   pthread_mutex_destroy(__mtx);
90 }
91 
mtx_init(mtx_t * _Nonnull __mtx,int __type)92 __BIONIC_THREADS_INLINE int mtx_init(mtx_t* _Nonnull __mtx, int __type) {
93   int __pthread_type = (__type & mtx_recursive) ? PTHREAD_MUTEX_RECURSIVE
94                                                 : PTHREAD_MUTEX_NORMAL;
95   __type &= ~mtx_recursive;
96   if (__type != mtx_plain && __type != mtx_timed) return thrd_error;
97 
98   pthread_mutexattr_t __attr;
99   pthread_mutexattr_init(&__attr);
100   pthread_mutexattr_settype(&__attr, __pthread_type);
101   return __bionic_thrd_error(pthread_mutex_init(__mtx, &__attr));
102 }
103 
mtx_lock(mtx_t * _Nonnull __mtx)104 __BIONIC_THREADS_INLINE int mtx_lock(mtx_t* _Nonnull __mtx) {
105   return __bionic_thrd_error(pthread_mutex_lock(__mtx));
106 }
107 
mtx_timedlock(mtx_t * _Nonnull __mtx,const struct timespec * _Nullable __timeout)108 __BIONIC_THREADS_INLINE int mtx_timedlock(mtx_t* _Nonnull __mtx,
109                                           const struct timespec* _Nullable __timeout) {
110   return __bionic_thrd_error(pthread_mutex_timedlock(__mtx, __timeout));
111 }
112 
mtx_trylock(mtx_t * _Nonnull __mtx)113 __BIONIC_THREADS_INLINE int mtx_trylock(mtx_t* _Nonnull __mtx) {
114   return __bionic_thrd_error(pthread_mutex_trylock(__mtx));
115 }
116 
mtx_unlock(mtx_t * _Nonnull __mtx)117 __BIONIC_THREADS_INLINE int mtx_unlock(mtx_t* _Nonnull __mtx) {
118   return __bionic_thrd_error(pthread_mutex_unlock(__mtx));
119 }
120 
121 struct __bionic_thrd_data {
122   thrd_start_t _Nonnull __func;
123   void* _Nullable __arg;
124 };
125 
__bionic_thrd_trampoline(void * _Nonnull __arg)126 static __inline void* _Nonnull __bionic_thrd_trampoline(void* _Nonnull __arg) {
127   struct __bionic_thrd_data __data =
128       *__BIONIC_CAST(static_cast, struct __bionic_thrd_data*, __arg);
129   free(__arg);
130   int __result = __data.__func(__data.__arg);
131   return __BIONIC_CAST(reinterpret_cast, void*,
132                        __BIONIC_CAST(static_cast, uintptr_t, __result));
133 }
134 
thrd_create(thrd_t * _Nonnull __thrd,thrd_start_t _Nonnull __func,void * _Nullable __arg)135 __BIONIC_THREADS_INLINE int thrd_create(thrd_t* _Nonnull __thrd,
136                                         thrd_start_t _Nonnull __func,
137                                         void* _Nullable __arg) {
138   struct __bionic_thrd_data* __pthread_arg =
139       __BIONIC_CAST(static_cast, struct __bionic_thrd_data*,
140                     malloc(sizeof(struct __bionic_thrd_data)));
141   __pthread_arg->__func = __func;
142   __pthread_arg->__arg = __arg;
143   int __result = __bionic_thrd_error(pthread_create(__thrd, NULL,
144                                                     __bionic_thrd_trampoline,
145                                                     __pthread_arg));
146   if (__result != thrd_success) free(__pthread_arg);
147   return __result;
148 }
149 
thrd_current(void)150 __BIONIC_THREADS_INLINE thrd_t thrd_current(void) {
151   return pthread_self();
152 }
153 
thrd_detach(thrd_t __thrd)154 __BIONIC_THREADS_INLINE int thrd_detach(thrd_t __thrd) {
155   return __bionic_thrd_error(pthread_detach(__thrd));
156 }
157 
thrd_equal(thrd_t __lhs,thrd_t __rhs)158 __BIONIC_THREADS_INLINE int thrd_equal(thrd_t __lhs, thrd_t __rhs) {
159   return pthread_equal(__lhs, __rhs);
160 }
161 
thrd_exit(int __result)162 __BIONIC_THREADS_INLINE void thrd_exit(int __result) {
163   pthread_exit(__BIONIC_CAST(reinterpret_cast, void*,
164                              __BIONIC_CAST(static_cast, uintptr_t, __result)));
165 }
166 
thrd_join(thrd_t __thrd,int * _Nullable __result)167 __BIONIC_THREADS_INLINE int thrd_join(thrd_t __thrd, int* _Nullable __result) {
168   void* __pthread_result;
169   if (pthread_join(__thrd, &__pthread_result) != 0) return thrd_error;
170   if (__result) {
171     *__result = __BIONIC_CAST(reinterpret_cast, intptr_t, __pthread_result);
172   }
173   return thrd_success;
174 }
175 
thrd_sleep(const struct timespec * _Nonnull __duration,struct timespec * _Nullable __remaining)176 __BIONIC_THREADS_INLINE int thrd_sleep(const struct timespec* _Nonnull __duration,
177                                        struct timespec* _Nullable __remaining) {
178   int __rc = nanosleep(__duration, __remaining);
179   if (__rc == 0) return 0;
180   return (errno == EINTR) ? -1 : -2;
181 }
182 
thrd_yield(void)183 __BIONIC_THREADS_INLINE void thrd_yield(void) {
184   sched_yield();
185 }
186 
187 
188 
tss_create(tss_t * _Nonnull __key,tss_dtor_t _Nullable __dtor)189 __BIONIC_THREADS_INLINE int tss_create(tss_t* _Nonnull __key, tss_dtor_t _Nullable __dtor) {
190   return __bionic_thrd_error(pthread_key_create(__key, __dtor));
191 }
192 
tss_delete(tss_t __key)193 __BIONIC_THREADS_INLINE void tss_delete(tss_t __key) {
194   pthread_key_delete(__key);
195 }
196 
tss_get(tss_t __key)197 __BIONIC_THREADS_INLINE void* _Nullable tss_get(tss_t __key) {
198   return pthread_getspecific(__key);
199 }
200 
tss_set(tss_t __key,void * _Nonnull __value)201 __BIONIC_THREADS_INLINE int tss_set(tss_t __key, void* _Nonnull __value) {
202   return __bionic_thrd_error(pthread_setspecific(__key, __value));
203 }
204 
205 __END_DECLS
206 
207 #endif  // __BIONIC_THREADS_INLINE
208