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 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); you may 11 * not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 */ 22 #ifndef MBEDTLS_THREADING_H 23 #define MBEDTLS_THREADING_H 24 #include "mbedtls/private_access.h" 25 26 #include "mbedtls/build_info.h" 27 28 #include <stdlib.h> 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 #define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C /**< Bad input parameters to function. */ 35 #define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E /**< Locking / unlocking / free failed with error code. */ 36 37 #if defined(MBEDTLS_THREADING_PTHREAD) 38 #include <pthread.h> 39 typedef struct mbedtls_threading_mutex_t 40 { 41 pthread_mutex_t MBEDTLS_PRIVATE(mutex); 42 /* is_valid is 0 after a failed init or a free, and nonzero after a 43 * successful init. This field is not considered part of the public 44 * API of Mbed TLS and may change without notice. */ 45 char MBEDTLS_PRIVATE(is_valid); 46 } mbedtls_threading_mutex_t; 47 #endif 48 49 #if defined(MBEDTLS_THREADING_ALT) 50 /* You should define the mbedtls_threading_mutex_t type in your header */ 51 #include "threading_alt.h" 52 53 /** 54 * \brief Set your alternate threading implementation function 55 * pointers and initialize global mutexes. If used, this 56 * function must be called once in the main thread before any 57 * other mbed TLS function is called, and 58 * mbedtls_threading_free_alt() must be called once in the main 59 * thread after all other mbed TLS functions. 60 * 61 * \note mutex_init() and mutex_free() don't return a status code. 62 * If mutex_init() fails, it should leave its argument (the 63 * mutex) in a state such that mutex_lock() will fail when 64 * called with this argument. 65 * 66 * \param mutex_init the init function implementation 67 * \param mutex_free the free function implementation 68 * \param mutex_lock the lock function implementation 69 * \param mutex_unlock the unlock function implementation 70 */ 71 void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ), 72 void (*mutex_free)( mbedtls_threading_mutex_t * ), 73 int (*mutex_lock)( mbedtls_threading_mutex_t * ), 74 int (*mutex_unlock)( mbedtls_threading_mutex_t * ) ); 75 76 /** 77 * \brief Free global mutexes. 78 */ 79 void mbedtls_threading_free_alt( void ); 80 #endif /* MBEDTLS_THREADING_ALT */ 81 82 #if defined(MBEDTLS_THREADING_C) 83 /* 84 * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock 85 * 86 * All these functions are expected to work or the result will be undefined. 87 */ 88 extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex ); 89 extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex ); 90 extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex ); 91 extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex ); 92 93 /* 94 * Global mutexes 95 */ 96 #if defined(MBEDTLS_FS_IO) 97 extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex; 98 #endif 99 100 #if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT) 101 /* This mutex may or may not be used in the default definition of 102 * mbedtls_platform_gmtime_r(), but in order to determine that, 103 * we need to check POSIX features, hence modify _POSIX_C_SOURCE. 104 * With the current approach, this declaration is orphaned, lacking 105 * an accompanying definition, in case mbedtls_platform_gmtime_r() 106 * doesn't need it, but that's not a problem. */ 107 extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex; 108 #endif /* MBEDTLS_HAVE_TIME_DATE && !MBEDTLS_PLATFORM_GMTIME_R_ALT */ 109 110 #endif /* MBEDTLS_THREADING_C */ 111 112 #ifdef __cplusplus 113 } 114 #endif 115 116 #endif /* threading.h */ 117
