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 * This file is provided under the Apache License 2.0, or the 11 * GNU General Public License v2.0 or later. 12 * 13 * ********** 14 * Apache License 2.0: 15 * 16 * Licensed under the Apache License, Version 2.0 (the "License"); you may 17 * not use this file except in compliance with the License. 18 * You may obtain a copy of the License at 19 * 20 * http://www.apache.org/licenses/LICENSE-2.0 21 * 22 * Unless required by applicable law or agreed to in writing, software 23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 25 * See the License for the specific language governing permissions and 26 * limitations under the License. 27 * 28 * ********** 29 * 30 * ********** 31 * GNU General Public License v2.0 or later: 32 * 33 * This program is free software; you can redistribute it and/or modify 34 * it under the terms of the GNU General Public License as published by 35 * the Free Software Foundation; either version 2 of the License, or 36 * (at your option) any later version. 37 * 38 * This program is distributed in the hope that it will be useful, 39 * but WITHOUT ANY WARRANTY; without even the implied warranty of 40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 41 * GNU General Public License for more details. 42 * 43 * You should have received a copy of the GNU General Public License along 44 * with this program; if not, write to the Free Software Foundation, Inc., 45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 46 * 47 * ********** 48 */ 49 #ifndef MBEDTLS_THREADING_H 50 #define MBEDTLS_THREADING_H 51 52 #if !defined(MBEDTLS_CONFIG_FILE) 53 #include "config.h" 54 #else 55 #include MBEDTLS_CONFIG_FILE 56 #endif 57 58 #include <stdlib.h> 59 60 #ifdef __cplusplus 61 extern "C" { 62 #endif 63 64 /* MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE is deprecated and should not be 65 * used. */ 66 #define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A /**< The selected feature is not available. */ 67 68 #define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C /**< Bad input parameters to function. */ 69 #define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E /**< Locking / unlocking / free failed with error code. */ 70 71 #if defined(MBEDTLS_THREADING_PTHREAD) 72 #include <pthread.h> 73 typedef struct mbedtls_threading_mutex_t 74 { 75 pthread_mutex_t mutex; 76 /* is_valid is 0 after a failed init or a free, and nonzero after a 77 * successful init. This field is not considered part of the public 78 * API of Mbed TLS and may change without notice. */ 79 char is_valid; 80 } mbedtls_threading_mutex_t; 81 #endif 82 83 #if defined(MBEDTLS_THREADING_ALT) 84 /* You should define the mbedtls_threading_mutex_t type in your header */ 85 #include "threading_alt.h" 86 87 /** 88 * \brief Set your alternate threading implementation function 89 * pointers and initialize global mutexes. If used, this 90 * function must be called once in the main thread before any 91 * other mbed TLS function is called, and 92 * mbedtls_threading_free_alt() must be called once in the main 93 * thread after all other mbed TLS functions. 94 * 95 * \note mutex_init() and mutex_free() don't return a status code. 96 * If mutex_init() fails, it should leave its argument (the 97 * mutex) in a state such that mutex_lock() will fail when 98 * called with this argument. 99 * 100 * \param mutex_init the init function implementation 101 * \param mutex_free the free function implementation 102 * \param mutex_lock the lock function implementation 103 * \param mutex_unlock the unlock function implementation 104 */ 105 void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ), 106 void (*mutex_free)( mbedtls_threading_mutex_t * ), 107 int (*mutex_lock)( mbedtls_threading_mutex_t * ), 108 int (*mutex_unlock)( mbedtls_threading_mutex_t * ) ); 109 110 /** 111 * \brief Free global mutexes. 112 */ 113 void mbedtls_threading_free_alt( void ); 114 #endif /* MBEDTLS_THREADING_ALT */ 115 116 #if defined(MBEDTLS_THREADING_C) 117 /* 118 * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock 119 * 120 * All these functions are expected to work or the result will be undefined. 121 */ 122 extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex ); 123 extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex ); 124 extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex ); 125 extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex ); 126 127 /* 128 * Global mutexes 129 */ 130 #if defined(MBEDTLS_FS_IO) 131 extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex; 132 #endif 133 134 #if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT) 135 /* This mutex may or may not be used in the default definition of 136 * mbedtls_platform_gmtime_r(), but in order to determine that, 137 * we need to check POSIX features, hence modify _POSIX_C_SOURCE. 138 * With the current approach, this declaration is orphaned, lacking 139 * an accompanying definition, in case mbedtls_platform_gmtime_r() 140 * doesn't need it, but that's not a problem. */ 141 extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex; 142 #endif /* MBEDTLS_HAVE_TIME_DATE && !MBEDTLS_PLATFORM_GMTIME_R_ALT */ 143 144 #endif /* MBEDTLS_THREADING_C */ 145 146 #ifdef __cplusplus 147 } 148 #endif 149 150 #endif /* threading.h */ 151