xref: /aosp_15_r20/external/libaom/aom_util/aom_pthread.h (revision 77c1e3ccc04c968bd2bc212e87364f250e820521)
1*77c1e3ccSAndroid Build Coastguard Worker /*
2*77c1e3ccSAndroid Build Coastguard Worker  * Copyright (c) 2024, Alliance for Open Media. All rights reserved.
3*77c1e3ccSAndroid Build Coastguard Worker  *
4*77c1e3ccSAndroid Build Coastguard Worker  * This source code is subject to the terms of the BSD 2 Clause License and
5*77c1e3ccSAndroid Build Coastguard Worker  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6*77c1e3ccSAndroid Build Coastguard Worker  * was not distributed with this source code in the LICENSE file, you can
7*77c1e3ccSAndroid Build Coastguard Worker  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8*77c1e3ccSAndroid Build Coastguard Worker  * Media Patent License 1.0 was not distributed with this source code in the
9*77c1e3ccSAndroid Build Coastguard Worker  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10*77c1e3ccSAndroid Build Coastguard Worker  */
11*77c1e3ccSAndroid Build Coastguard Worker //
12*77c1e3ccSAndroid Build Coastguard Worker // pthread.h wrapper
13*77c1e3ccSAndroid Build Coastguard Worker 
14*77c1e3ccSAndroid Build Coastguard Worker #ifndef AOM_AOM_UTIL_AOM_PTHREAD_H_
15*77c1e3ccSAndroid Build Coastguard Worker #define AOM_AOM_UTIL_AOM_PTHREAD_H_
16*77c1e3ccSAndroid Build Coastguard Worker 
17*77c1e3ccSAndroid Build Coastguard Worker #include "config/aom_config.h"
18*77c1e3ccSAndroid Build Coastguard Worker 
19*77c1e3ccSAndroid Build Coastguard Worker #if CONFIG_MULTITHREAD
20*77c1e3ccSAndroid Build Coastguard Worker 
21*77c1e3ccSAndroid Build Coastguard Worker #ifdef __cplusplus
22*77c1e3ccSAndroid Build Coastguard Worker extern "C" {
23*77c1e3ccSAndroid Build Coastguard Worker #endif
24*77c1e3ccSAndroid Build Coastguard Worker 
25*77c1e3ccSAndroid Build Coastguard Worker #if defined(_WIN32) && !HAVE_PTHREAD_H
26*77c1e3ccSAndroid Build Coastguard Worker // Prevent leaking max/min macros.
27*77c1e3ccSAndroid Build Coastguard Worker #undef NOMINMAX
28*77c1e3ccSAndroid Build Coastguard Worker #define NOMINMAX
29*77c1e3ccSAndroid Build Coastguard Worker #undef WIN32_LEAN_AND_MEAN
30*77c1e3ccSAndroid Build Coastguard Worker #define WIN32_LEAN_AND_MEAN
31*77c1e3ccSAndroid Build Coastguard Worker #include <errno.h>    // NOLINT
32*77c1e3ccSAndroid Build Coastguard Worker #include <process.h>  // NOLINT
33*77c1e3ccSAndroid Build Coastguard Worker #include <stddef.h>   // NOLINT
34*77c1e3ccSAndroid Build Coastguard Worker #include <windows.h>  // NOLINT
35*77c1e3ccSAndroid Build Coastguard Worker typedef HANDLE pthread_t;
36*77c1e3ccSAndroid Build Coastguard Worker typedef int pthread_attr_t;
37*77c1e3ccSAndroid Build Coastguard Worker typedef CRITICAL_SECTION pthread_mutex_t;
38*77c1e3ccSAndroid Build Coastguard Worker 
39*77c1e3ccSAndroid Build Coastguard Worker #if _WIN32_WINNT < 0x0600
40*77c1e3ccSAndroid Build Coastguard Worker #error _WIN32_WINNT must target Windows Vista / Server 2008 or newer.
41*77c1e3ccSAndroid Build Coastguard Worker #endif
42*77c1e3ccSAndroid Build Coastguard Worker typedef CONDITION_VARIABLE pthread_cond_t;
43*77c1e3ccSAndroid Build Coastguard Worker 
44*77c1e3ccSAndroid Build Coastguard Worker #ifndef WINAPI_FAMILY_PARTITION
45*77c1e3ccSAndroid Build Coastguard Worker #define WINAPI_PARTITION_DESKTOP 1
46*77c1e3ccSAndroid Build Coastguard Worker #define WINAPI_FAMILY_PARTITION(x) x
47*77c1e3ccSAndroid Build Coastguard Worker #endif
48*77c1e3ccSAndroid Build Coastguard Worker 
49*77c1e3ccSAndroid Build Coastguard Worker #if !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
50*77c1e3ccSAndroid Build Coastguard Worker #define USE_CREATE_THREAD
51*77c1e3ccSAndroid Build Coastguard Worker #endif
52*77c1e3ccSAndroid Build Coastguard Worker 
53*77c1e3ccSAndroid Build Coastguard Worker //------------------------------------------------------------------------------
54*77c1e3ccSAndroid Build Coastguard Worker // simplistic pthread emulation layer
55*77c1e3ccSAndroid Build Coastguard Worker 
56*77c1e3ccSAndroid Build Coastguard Worker // _beginthreadex requires __stdcall
57*77c1e3ccSAndroid Build Coastguard Worker #if defined(__GNUC__) && \
58*77c1e3ccSAndroid Build Coastguard Worker     (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 2))
59*77c1e3ccSAndroid Build Coastguard Worker #define THREADFN __attribute__((force_align_arg_pointer)) unsigned int __stdcall
60*77c1e3ccSAndroid Build Coastguard Worker #else
61*77c1e3ccSAndroid Build Coastguard Worker #define THREADFN unsigned int __stdcall
62*77c1e3ccSAndroid Build Coastguard Worker #endif
63*77c1e3ccSAndroid Build Coastguard Worker #define THREAD_EXIT_SUCCESS 0
64*77c1e3ccSAndroid Build Coastguard Worker 
pthread_attr_init(pthread_attr_t * attr)65*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_attr_init(pthread_attr_t *attr) {
66*77c1e3ccSAndroid Build Coastguard Worker   (void)attr;
67*77c1e3ccSAndroid Build Coastguard Worker   return 0;
68*77c1e3ccSAndroid Build Coastguard Worker }
69*77c1e3ccSAndroid Build Coastguard Worker 
pthread_attr_destroy(pthread_attr_t * attr)70*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_attr_destroy(pthread_attr_t *attr) {
71*77c1e3ccSAndroid Build Coastguard Worker   (void)attr;
72*77c1e3ccSAndroid Build Coastguard Worker   return 0;
73*77c1e3ccSAndroid Build Coastguard Worker }
74*77c1e3ccSAndroid Build Coastguard Worker 
pthread_attr_getstacksize(const pthread_attr_t * attr,size_t * stacksize)75*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_attr_getstacksize(const pthread_attr_t *attr,
76*77c1e3ccSAndroid Build Coastguard Worker                                             size_t *stacksize) {
77*77c1e3ccSAndroid Build Coastguard Worker   (void)attr;
78*77c1e3ccSAndroid Build Coastguard Worker   (void)stacksize;
79*77c1e3ccSAndroid Build Coastguard Worker   return EINVAL;
80*77c1e3ccSAndroid Build Coastguard Worker }
81*77c1e3ccSAndroid Build Coastguard Worker 
pthread_attr_setstacksize(pthread_attr_t * attr,size_t stacksize)82*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_attr_setstacksize(pthread_attr_t *attr,
83*77c1e3ccSAndroid Build Coastguard Worker                                             size_t stacksize) {
84*77c1e3ccSAndroid Build Coastguard Worker   (void)attr;
85*77c1e3ccSAndroid Build Coastguard Worker   (void)stacksize;
86*77c1e3ccSAndroid Build Coastguard Worker   return EINVAL;
87*77c1e3ccSAndroid Build Coastguard Worker }
88*77c1e3ccSAndroid Build Coastguard Worker 
pthread_create(pthread_t * const thread,const pthread_attr_t * attr,unsigned int (__stdcall * start)(void *),void * arg)89*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_create(pthread_t *const thread,
90*77c1e3ccSAndroid Build Coastguard Worker                                  const pthread_attr_t *attr,
91*77c1e3ccSAndroid Build Coastguard Worker                                  unsigned int(__stdcall *start)(void *),
92*77c1e3ccSAndroid Build Coastguard Worker                                  void *arg) {
93*77c1e3ccSAndroid Build Coastguard Worker   (void)attr;
94*77c1e3ccSAndroid Build Coastguard Worker #ifdef USE_CREATE_THREAD
95*77c1e3ccSAndroid Build Coastguard Worker   *thread = CreateThread(NULL,          /* lpThreadAttributes */
96*77c1e3ccSAndroid Build Coastguard Worker                          0,             /* dwStackSize */
97*77c1e3ccSAndroid Build Coastguard Worker                          start, arg, 0, /* dwStackSize */
98*77c1e3ccSAndroid Build Coastguard Worker                          NULL);         /* lpThreadId */
99*77c1e3ccSAndroid Build Coastguard Worker #else
100*77c1e3ccSAndroid Build Coastguard Worker   *thread = (pthread_t)_beginthreadex(NULL,          /* void *security */
101*77c1e3ccSAndroid Build Coastguard Worker                                       0,             /* unsigned stack_size */
102*77c1e3ccSAndroid Build Coastguard Worker                                       start, arg, 0, /* unsigned initflag */
103*77c1e3ccSAndroid Build Coastguard Worker                                       NULL);         /* unsigned *thrdaddr */
104*77c1e3ccSAndroid Build Coastguard Worker #endif
105*77c1e3ccSAndroid Build Coastguard Worker   if (*thread == NULL) return 1;
106*77c1e3ccSAndroid Build Coastguard Worker   SetThreadPriority(*thread, THREAD_PRIORITY_ABOVE_NORMAL);
107*77c1e3ccSAndroid Build Coastguard Worker   return 0;
108*77c1e3ccSAndroid Build Coastguard Worker }
109*77c1e3ccSAndroid Build Coastguard Worker 
pthread_join(pthread_t thread,void ** value_ptr)110*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_join(pthread_t thread, void **value_ptr) {
111*77c1e3ccSAndroid Build Coastguard Worker   (void)value_ptr;
112*77c1e3ccSAndroid Build Coastguard Worker   return (WaitForSingleObjectEx(thread, INFINITE, FALSE /*bAlertable*/) !=
113*77c1e3ccSAndroid Build Coastguard Worker               WAIT_OBJECT_0 ||
114*77c1e3ccSAndroid Build Coastguard Worker           CloseHandle(thread) == 0);
115*77c1e3ccSAndroid Build Coastguard Worker }
116*77c1e3ccSAndroid Build Coastguard Worker 
117*77c1e3ccSAndroid Build Coastguard Worker // Mutex
pthread_mutex_init(pthread_mutex_t * const mutex,void * mutexattr)118*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_mutex_init(pthread_mutex_t *const mutex,
119*77c1e3ccSAndroid Build Coastguard Worker                                      void *mutexattr) {
120*77c1e3ccSAndroid Build Coastguard Worker   (void)mutexattr;
121*77c1e3ccSAndroid Build Coastguard Worker   InitializeCriticalSectionEx(mutex, 0 /*dwSpinCount*/, 0 /*Flags*/);
122*77c1e3ccSAndroid Build Coastguard Worker   return 0;
123*77c1e3ccSAndroid Build Coastguard Worker }
124*77c1e3ccSAndroid Build Coastguard Worker 
pthread_mutex_trylock(pthread_mutex_t * const mutex)125*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_mutex_trylock(pthread_mutex_t *const mutex) {
126*77c1e3ccSAndroid Build Coastguard Worker   return TryEnterCriticalSection(mutex) ? 0 : EBUSY;
127*77c1e3ccSAndroid Build Coastguard Worker }
128*77c1e3ccSAndroid Build Coastguard Worker 
pthread_mutex_lock(pthread_mutex_t * const mutex)129*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_mutex_lock(pthread_mutex_t *const mutex) {
130*77c1e3ccSAndroid Build Coastguard Worker   EnterCriticalSection(mutex);
131*77c1e3ccSAndroid Build Coastguard Worker   return 0;
132*77c1e3ccSAndroid Build Coastguard Worker }
133*77c1e3ccSAndroid Build Coastguard Worker 
pthread_mutex_unlock(pthread_mutex_t * const mutex)134*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_mutex_unlock(pthread_mutex_t *const mutex) {
135*77c1e3ccSAndroid Build Coastguard Worker   LeaveCriticalSection(mutex);
136*77c1e3ccSAndroid Build Coastguard Worker   return 0;
137*77c1e3ccSAndroid Build Coastguard Worker }
138*77c1e3ccSAndroid Build Coastguard Worker 
pthread_mutex_destroy(pthread_mutex_t * const mutex)139*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_mutex_destroy(pthread_mutex_t *const mutex) {
140*77c1e3ccSAndroid Build Coastguard Worker   DeleteCriticalSection(mutex);
141*77c1e3ccSAndroid Build Coastguard Worker   return 0;
142*77c1e3ccSAndroid Build Coastguard Worker }
143*77c1e3ccSAndroid Build Coastguard Worker 
144*77c1e3ccSAndroid Build Coastguard Worker // Condition
pthread_cond_destroy(pthread_cond_t * const condition)145*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_cond_destroy(pthread_cond_t *const condition) {
146*77c1e3ccSAndroid Build Coastguard Worker   (void)condition;
147*77c1e3ccSAndroid Build Coastguard Worker   return 0;
148*77c1e3ccSAndroid Build Coastguard Worker }
149*77c1e3ccSAndroid Build Coastguard Worker 
pthread_cond_init(pthread_cond_t * const condition,void * cond_attr)150*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_cond_init(pthread_cond_t *const condition,
151*77c1e3ccSAndroid Build Coastguard Worker                                     void *cond_attr) {
152*77c1e3ccSAndroid Build Coastguard Worker   (void)cond_attr;
153*77c1e3ccSAndroid Build Coastguard Worker   InitializeConditionVariable(condition);
154*77c1e3ccSAndroid Build Coastguard Worker   return 0;
155*77c1e3ccSAndroid Build Coastguard Worker }
156*77c1e3ccSAndroid Build Coastguard Worker 
pthread_cond_signal(pthread_cond_t * const condition)157*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_cond_signal(pthread_cond_t *const condition) {
158*77c1e3ccSAndroid Build Coastguard Worker   WakeConditionVariable(condition);
159*77c1e3ccSAndroid Build Coastguard Worker   return 0;
160*77c1e3ccSAndroid Build Coastguard Worker }
161*77c1e3ccSAndroid Build Coastguard Worker 
pthread_cond_broadcast(pthread_cond_t * const condition)162*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_cond_broadcast(pthread_cond_t *const condition) {
163*77c1e3ccSAndroid Build Coastguard Worker   WakeAllConditionVariable(condition);
164*77c1e3ccSAndroid Build Coastguard Worker   return 0;
165*77c1e3ccSAndroid Build Coastguard Worker }
166*77c1e3ccSAndroid Build Coastguard Worker 
pthread_cond_wait(pthread_cond_t * const condition,pthread_mutex_t * const mutex)167*77c1e3ccSAndroid Build Coastguard Worker static inline int pthread_cond_wait(pthread_cond_t *const condition,
168*77c1e3ccSAndroid Build Coastguard Worker                                     pthread_mutex_t *const mutex) {
169*77c1e3ccSAndroid Build Coastguard Worker   int ok;
170*77c1e3ccSAndroid Build Coastguard Worker   ok = SleepConditionVariableCS(condition, mutex, INFINITE);
171*77c1e3ccSAndroid Build Coastguard Worker   return !ok;
172*77c1e3ccSAndroid Build Coastguard Worker }
173*77c1e3ccSAndroid Build Coastguard Worker #else                 // _WIN32
174*77c1e3ccSAndroid Build Coastguard Worker #include <pthread.h>  // NOLINT
175*77c1e3ccSAndroid Build Coastguard Worker #define THREADFN void *
176*77c1e3ccSAndroid Build Coastguard Worker #define THREAD_EXIT_SUCCESS NULL
177*77c1e3ccSAndroid Build Coastguard Worker #endif
178*77c1e3ccSAndroid Build Coastguard Worker 
179*77c1e3ccSAndroid Build Coastguard Worker #ifdef __cplusplus
180*77c1e3ccSAndroid Build Coastguard Worker }  // extern "C"
181*77c1e3ccSAndroid Build Coastguard Worker #endif
182*77c1e3ccSAndroid Build Coastguard Worker 
183*77c1e3ccSAndroid Build Coastguard Worker #endif  // CONFIG_MULTITHREAD
184*77c1e3ccSAndroid Build Coastguard Worker 
185*77c1e3ccSAndroid Build Coastguard Worker #endif  // AOM_AOM_UTIL_AOM_PTHREAD_H_
186