1 /** 2 * \file threading.h 3 * 4 * \brief Threading abstraction layer 5 * 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 7 * SPDX-License-Identifier: Apache-2.0 8 * 9 * Licensed under the Apache License, Version 2.0 (the "License"); you may 10 * not use this file except in compliance with the License. 11 * You may obtain a copy of the License at 12 * 13 * http://www.apache.org/licenses/LICENSE-2.0 14 * 15 * Unless required by applicable law or agreed to in writing, software 16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 18 * See the License for the specific language governing permissions and 19 * limitations under the License. 20 * 21 * This file is part of mbed TLS (https://tls.mbed.org) 22 */ 23 #ifndef MBEDTLS_THREADING_H 24 #define MBEDTLS_THREADING_H 25 26 #if !defined(MBEDTLS_CONFIG_FILE) 27 #include "config.h" 28 #else 29 #include MBEDTLS_CONFIG_FILE 30 #endif 31 32 #include <stdlib.h> 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 #define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A /**< The selected feature is not available. */ 39 #define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C /**< Bad input parameters to function. */ 40 #define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E /**< Locking / unlocking / free failed with error code. */ 41 42 #if defined(MBEDTLS_THREADING_PTHREAD) 43 #include <pthread.h> 44 typedef struct 45 { 46 pthread_mutex_t mutex; 47 char is_valid; 48 } mbedtls_threading_mutex_t; 49 #endif 50 51 #if defined(MBEDTLS_THREADING_ALT) 52 /* You should define the mbedtls_threading_mutex_t type in your header */ 53 #include "threading_alt.h" 54 55 /** 56 * \brief Set your alternate threading implementation function 57 * pointers and initialize global mutexes. If used, this 58 * function must be called once in the main thread before any 59 * other mbed TLS function is called, and 60 * mbedtls_threading_free_alt() must be called once in the main 61 * thread after all other mbed TLS functions. 62 * 63 * \note mutex_init() and mutex_free() don't return a status code. 64 * If mutex_init() fails, it should leave its argument (the 65 * mutex) in a state such that mutex_lock() will fail when 66 * called with this argument. 67 * 68 * \param mutex_init the init function implementation 69 * \param mutex_free the free function implementation 70 * \param mutex_lock the lock function implementation 71 * \param mutex_unlock the unlock function implementation 72 */ 73 void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ), 74 void (*mutex_free)( mbedtls_threading_mutex_t * ), 75 int (*mutex_lock)( mbedtls_threading_mutex_t * ), 76 int (*mutex_unlock)( mbedtls_threading_mutex_t * ) ); 77 78 /** 79 * \brief Free global mutexes. 80 */ 81 void mbedtls_threading_free_alt( void ); 82 #endif /* MBEDTLS_THREADING_ALT */ 83 84 #if defined(MBEDTLS_THREADING_C) 85 /* 86 * The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock 87 * 88 * All these functions are expected to work or the result will be undefined. 89 */ 90 extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex ); 91 extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex ); 92 extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex ); 93 extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex ); 94 95 /* 96 * Global mutexes 97 */ 98 extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex; 99 extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex; 100 #endif /* MBEDTLS_THREADING_C */ 101 102 #ifdef __cplusplus 103 } 104 #endif 105 106 #endif /* threading.h */ 107
