127 lines
4.5 KiB
C++
127 lines
4.5 KiB
C++
/**
|
|
* \file threading.h
|
|
*
|
|
* \brief Threading abstraction layer
|
|
*/
|
|
/*
|
|
* Copyright The Mbed TLS Contributors
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#ifndef MBEDTLS_THREADING_H
|
|
#define MBEDTLS_THREADING_H
|
|
|
|
#if !defined(MBEDTLS_CONFIG_FILE)
|
|
#include "mbedtls/config.h"
|
|
#else
|
|
#include MBEDTLS_CONFIG_FILE
|
|
#endif
|
|
|
|
#include <stdlib.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE is deprecated and should not be
|
|
* used. */
|
|
/** The selected feature is not available. */
|
|
#define MBEDTLS_ERR_THREADING_FEATURE_UNAVAILABLE -0x001A
|
|
|
|
/** Bad input parameters to function. */
|
|
#define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C
|
|
/** Locking / unlocking / free failed with error code. */
|
|
#define MBEDTLS_ERR_THREADING_MUTEX_ERROR -0x001E
|
|
|
|
#if defined(MBEDTLS_THREADING_PTHREAD)
|
|
#include <pthread.h>
|
|
typedef struct mbedtls_threading_mutex_t
|
|
{
|
|
pthread_mutex_t mutex;
|
|
/* is_valid is 0 after a failed init or a free, and nonzero after a
|
|
* successful init. This field is not considered part of the public
|
|
* API of Mbed TLS and may change without notice. */
|
|
char is_valid;
|
|
} mbedtls_threading_mutex_t;
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_THREADING_ALT)
|
|
/* You should define the mbedtls_threading_mutex_t type in your header */
|
|
#include "threading_alt.h"
|
|
|
|
/**
|
|
* \brief Set your alternate threading implementation function
|
|
* pointers and initialize global mutexes. If used, this
|
|
* function must be called once in the main thread before any
|
|
* other mbed TLS function is called, and
|
|
* mbedtls_threading_free_alt() must be called once in the main
|
|
* thread after all other mbed TLS functions.
|
|
*
|
|
* \note mutex_init() and mutex_free() don't return a status code.
|
|
* If mutex_init() fails, it should leave its argument (the
|
|
* mutex) in a state such that mutex_lock() will fail when
|
|
* called with this argument.
|
|
*
|
|
* \param mutex_init the init function implementation
|
|
* \param mutex_free the free function implementation
|
|
* \param mutex_lock the lock function implementation
|
|
* \param mutex_unlock the unlock function implementation
|
|
*/
|
|
void mbedtls_threading_set_alt( void (*mutex_init)( mbedtls_threading_mutex_t * ),
|
|
void (*mutex_free)( mbedtls_threading_mutex_t * ),
|
|
int (*mutex_lock)( mbedtls_threading_mutex_t * ),
|
|
int (*mutex_unlock)( mbedtls_threading_mutex_t * ) );
|
|
|
|
/**
|
|
* \brief Free global mutexes.
|
|
*/
|
|
void mbedtls_threading_free_alt( void );
|
|
#endif /* MBEDTLS_THREADING_ALT */
|
|
|
|
#if defined(MBEDTLS_THREADING_C)
|
|
/*
|
|
* The function pointers for mutex_init, mutex_free, mutex_ and mutex_unlock
|
|
*
|
|
* All these functions are expected to work or the result will be undefined.
|
|
*/
|
|
extern void (*mbedtls_mutex_init)( mbedtls_threading_mutex_t *mutex );
|
|
extern void (*mbedtls_mutex_free)( mbedtls_threading_mutex_t *mutex );
|
|
extern int (*mbedtls_mutex_lock)( mbedtls_threading_mutex_t *mutex );
|
|
extern int (*mbedtls_mutex_unlock)( mbedtls_threading_mutex_t *mutex );
|
|
|
|
/*
|
|
* Global mutexes
|
|
*/
|
|
#if defined(MBEDTLS_FS_IO)
|
|
extern mbedtls_threading_mutex_t mbedtls_threading_readdir_mutex;
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT)
|
|
/* This mutex may or may not be used in the default definition of
|
|
* mbedtls_platform_gmtime_r(), but in order to determine that,
|
|
* we need to check POSIX features, hence modify _POSIX_C_SOURCE.
|
|
* With the current approach, this declaration is orphaned, lacking
|
|
* an accompanying definition, in case mbedtls_platform_gmtime_r()
|
|
* doesn't need it, but that's not a problem. */
|
|
extern mbedtls_threading_mutex_t mbedtls_threading_gmtime_mutex;
|
|
#endif /* MBEDTLS_HAVE_TIME_DATE && !MBEDTLS_PLATFORM_GMTIME_R_ALT */
|
|
|
|
#endif /* MBEDTLS_THREADING_C */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* threading.h */
|