mirror of
https://github.com/Mbed-TLS/mbedtls-framework.git
synced 2026-06-06 05:25:18 +00:00
Gilles Peskine
6d5987a954
This lets us define things that we want to have everywhere in test code. In particular, this lets us define platform-specific symbols that influence what system headers declare. This also takes care of including the library configuration. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
120 lines
3.8 KiB
C
120 lines
3.8 KiB
C
/**
|
|
* \file threading_helpers.h
|
|
*
|
|
* \brief This file contains the prototypes of helper functions for the purpose
|
|
* of testing threading.
|
|
*/
|
|
|
|
/*
|
|
* Copyright The Mbed TLS Contributors
|
|
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
|
|
*/
|
|
|
|
#ifndef THREADING_HELPERS_H
|
|
#define THREADING_HELPERS_H
|
|
|
|
#include "test_common.h"
|
|
|
|
#if defined MBEDTLS_THREADING_C
|
|
|
|
#include <mbedtls/threading.h>
|
|
|
|
/* Error in thread management */
|
|
#define MBEDTLS_ERR_THREADING_THREAD_ERROR -0x001F
|
|
|
|
/* Error in mutex usage (used in Mbed TLS up to 3.6, no longer used
|
|
* outside the test framework since TF-PSA-Crypto 1.0).
|
|
*
|
|
* In Mbed TLS 3.5, this is a redefinition of the macro to the same
|
|
* value (down to the exact sequence of tokens and presence/absence of
|
|
* whitespace between tokens), which is valid C.
|
|
*/
|
|
#define MBEDTLS_ERR_THREADING_BAD_INPUT_DATA -0x001C
|
|
|
|
|
|
#if defined(MBEDTLS_THREADING_PTHREAD)
|
|
#include <pthread.h>
|
|
#endif /* MBEDTLS_THREADING_PTHREAD */
|
|
|
|
#if defined(MBEDTLS_THREADING_ALT)
|
|
/* You should define the mbedtls_test_thread_t type in your header */
|
|
#include "threading_alt.h"
|
|
|
|
/**
|
|
* \brief Set your alternate threading implementation
|
|
* function pointers for test threads. If used, this
|
|
* function must be called once in the main thread
|
|
* before any other MbedTLS function is called.
|
|
*
|
|
* \note These functions are part of the testing API only and
|
|
* thus not considered part of the public API of
|
|
* MbedTLS and thus may change without notice.
|
|
*
|
|
* \param thread_create The thread create function implementation.
|
|
* \param thread_join The thread join function implementation.
|
|
|
|
*/
|
|
void mbedtls_test_thread_set_alt(int (*thread_create)(mbedtls_test_thread_t *thread,
|
|
void *(*thread_func)(
|
|
void *),
|
|
void *thread_data),
|
|
int (*thread_join)(mbedtls_test_thread_t *thread));
|
|
|
|
#else /* MBEDTLS_THREADING_ALT*/
|
|
|
|
typedef struct mbedtls_test_thread_t {
|
|
|
|
#if defined(MBEDTLS_THREADING_PTHREAD)
|
|
pthread_t MBEDTLS_PRIVATE(thread);
|
|
#else /* MBEDTLS_THREADING_PTHREAD */
|
|
/* Make sure this struct is always non-empty */
|
|
unsigned dummy;
|
|
#endif
|
|
|
|
} mbedtls_test_thread_t;
|
|
|
|
#endif /* MBEDTLS_THREADING_ALT*/
|
|
|
|
/**
|
|
* \brief The function pointers for thread create and thread
|
|
* join.
|
|
*
|
|
* \note These functions are part of the testing API only
|
|
* and thus not considered part of the public API of
|
|
* MbedTLS and thus may change without notice.
|
|
*
|
|
* \note All these functions are expected to work or
|
|
* the result will be undefined.
|
|
*/
|
|
extern int (*mbedtls_test_thread_create)(mbedtls_test_thread_t *thread,
|
|
void *(*thread_func)(void *), void *thread_data);
|
|
extern int (*mbedtls_test_thread_join)(mbedtls_test_thread_t *thread);
|
|
|
|
#if defined(MBEDTLS_THREADING_PTHREAD) && defined(MBEDTLS_TEST_HOOKS)
|
|
#define MBEDTLS_TEST_MUTEX_USAGE
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_TEST_MUTEX_USAGE)
|
|
/**
|
|
* Activate the mutex usage verification framework. See threading_helpers.c for
|
|
* information.
|
|
*/
|
|
void mbedtls_test_mutex_usage_init(void);
|
|
|
|
/**
|
|
* Deactivate the mutex usage verification framework. See threading_helpers.c
|
|
* for information.
|
|
*/
|
|
void mbedtls_test_mutex_usage_end(void);
|
|
|
|
/**
|
|
* Call this function after executing a test case to check for mutex usage
|
|
* errors.
|
|
*/
|
|
void mbedtls_test_mutex_usage_check(void);
|
|
#endif /* MBEDTLS_TEST_MUTEX_USAGE */
|
|
|
|
#endif /* MBEDTLS_THREADING_C */
|
|
|
|
#endif /* THREADING_HELPERS_H */
|