1 /** 2 * \file threading.h 3 * 4 * \brief Threading abstraction layer 5 */ 6 /* 7 * Copyright The Mbed TLS Contributors 8 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 9 */ 10 #ifndef MBEDTLS_THREADING_H 11 #define MBEDTLS_THREADING_H 12 #include "mbedtls/private_access.h" 13 14 #include "mbedtls/build_info.h" 15 16 #include <stdlib.h> 17 18 #ifdef __cplusplus 19 extern "C" { 20 #endif 21 22 /** Bad input parameters to function. */ 23 #define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C 24 /** Locking / unlocking / free failed with error code. */ 25 #define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E 26 27 #if defined(MBEDTLS_THREADING_PTHREAD) 28 #include <pthread.h> 29 typedef struct mbedtls_threading_mutex_t { 30 pthread_mutex_t MBEDTLS_PRIVATE(mutex); 31 /* is_valid is 0 after a failed init or a free, and nonzero after a 32 * successful init. This field is not considered part of the public 33 * API of Mbed TLS and may change without notice. */ 34 char MBEDTLS_PRIVATE(is_valid); 35 } mbedtls_threading_mutex_t; 36 #endif 37 38 #if defined(MBEDTLS_THREADING_ALT) 39 /* You should define the mbedtls_threading_mutex_t type in your header */ 40 #include "threading_alt.h" 41 42 /** 43 * \brief Set your alternate threading implementation function 44 * pointers and initialize global mutexes. If used, this 45 * function must be called once in the main thread before any 46 * other Mbed TLS function is called, and 47 * mbedtls_threading_free_alt() must be called once in the main 48 * thread after all other Mbed TLS functions. 49 * 50 * \note mutex_init() and mutex_free() don't return a status code. 51 * If mutex_init() fails, it should leave its argument (the 52 * mutex) in a state such that mutex_lock() will fail when 53 * called with this argument. 54 * 55 * \param mutex_init the init function implementation 56 * \param mutex_free the free function implementation 57 * \param mutex_lock the lock function implementation 58 * \param mutex_unlock the unlock function implementation 59 */ 60 void mbedtls_threading_set_alt(void (*mutex_init)(mbedtls_threading_mutex_t *), 61 void (*mutex_free)(mbedtls_threading_mutex_t *), 62 int (*mutex_lock)(mbedtls_threading_mutex_t *), 63 int (*mutex_unlock)(mbedtls_threading_mutex_t *)); 64 65 /** 66 * \brief Free global mutexes. 67 */ 68 void mbedtls_threading_free_alt(void); 69 #endif /* MBEDTLS_THREADING_ALT */ 70 71 #if defined(MBEDTLS_THREADING_C) 72 /* 73 * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock 74 * 75 * All these functions are expected to work or the result will be undefined. 76 */ 77 extern void (*mbedtls_mutex_init)(mbedtls_threading_mutex_t *mutex); 78 extern void (*mbedtls_mutex_free)(mbedtls_threading_mutex_t *mutex); 79 extern int (*mbedtls_mutex_lock)(mbedtls_threading_mutex_t *mutex); 80 extern int (*mbedtls_mutex_unlock)(mbedtls_threading_mutex_t *mutex); 81 82 /* 83 * Global mutexes 84 */ 85 #if defined(MBEDTLS_FS_IO) 86 extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex; 87 #endif 88 89 #if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT) 90 /* This mutex may or may not be used in the default definition of 91 * mbedtls_platform_gmtime_r(), but in order to determine that, 92 * we need to check POSIX features, hence modify _POSIX_C_SOURCE. 93 * With the current approach, this declaration is orphaned, lacking 94 * an accompanying definition, in case mbedtls_platform_gmtime_r() 95 * doesn't need it, but that's not a problem. */ 96 extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex; 97 #endif /* MBEDTLS_HAVE_TIME_DATE && !MBEDTLS_PLATFORM_GMTIME_R_ALT */ 98 99 #endif /* MBEDTLS_THREADING_C */ 100 101 #ifdef __cplusplus 102 } 103 #endif 104 105 #endif /* threading.h */ 106
