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