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 25 #if !defined(MBEDTLS_CONFIG_FILE) 26 #include "mbedtls/config.h" 27 #else 28 #include MBEDTLS_CONFIG_FILE 29 #endif 30 31 #include <stdlib.h> 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 /* MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE is deprecated and should not be 38 * used. */ 39 #define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A /**< The selected feature is not available. */ 40 41 #define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C /**< Bad input parameters to function. */ 42 #define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E /**< Locking / unlocking / free failed with error code. */ 43 44 #if defined(MBEDTLS_THREADING_PTHREAD) 45 #include <pthread.h> 46 typedef struct mbedtls_threading_mutex_t 47 { 48 pthread_mutex_t mutex; 49 /* is_valid is 0 after a failed init or a free, and nonzero after a 50 * successful init. This field is not considered part of the public 51 * API of Mbed TLS and may change without notice. */ 52 char is_valid; 53 } mbedtls_threading_mutex_t; 54 #endif 55 56 #if defined(MBEDTLS_THREADING_ALT) 57 /* You should define the mbedtls_threading_mutex_t type in your header */ 58 #include "threading_alt.h" 59 60 /** 61 * \brief Set your alternate threading implementation function 62 * pointers and initialize global mutexes. If used, this 63 * function must be called once in the main thread before any 64 * other mbed TLS function is called, and 65 * mbedtls_threading_free_alt() must be called once in the main 66 * thread after all other mbed TLS functions. 67 * 68 * \note mutex_init() and mutex_free() don't return a status code. 69 * If mutex_init() fails, it should leave its argument (the 70 * mutex) in a state such that mutex_lock() will fail when 71 * called with this argument. 72 * 73 * \param mutex_init the init function implementation 74 * \param mutex_free the free function implementation 75 * \param mutex_lock the lock function implementation 76 * \param mutex_unlock the unlock function implementation 77 */ 78 void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ), 79 void (*mutex_free)( mbedtls_threading_mutex_t * ), 80 int (*mutex_lock)( mbedtls_threading_mutex_t * ), 81 int (*mutex_unlock)( mbedtls_threading_mutex_t * ) ); 82 83 /** 84 * \brief Free global mutexes. 85 */ 86 void mbedtls_threading_free_alt( void ); 87 #endif /* MBEDTLS_THREADING_ALT */ 88 89 #if defined(MBEDTLS_THREADING_C) 90 /* 91 * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock 92 * 93 * All these functions are expected to work or the result will be undefined. 94 */ 95 extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex ); 96 extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex ); 97 extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex ); 98 extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex ); 99 100 /* 101 * Global mutexes 102 */ 103 #if defined(MBEDTLS_FS_IO) 104 extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex; 105 #endif 106 107 #if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT) 108 /* This mutex may or may not be used in the default definition of 109 * mbedtls_platform_gmtime_r(), but in order to determine that, 110 * we need to check POSIX features, hence modify _POSIX_C_SOURCE. 111 * With the current approach, this declaration is orphaned, lacking 112 * an accompanying definition, in case mbedtls_platform_gmtime_r() 113 * doesn't need it, but that's not a problem. */ 114 extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex; 115 #endif /* MBEDTLS_HAVE_TIME_DATE && !MBEDTLS_PLATFORM_GMTIME_R_ALT */ 116 117 #endif /* MBEDTLS_THREADING_C */ 118 119 #ifdef __cplusplus 120 } 121 #endif 122 123 #endif /* threading.h */ 124