mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-23 16:20:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation / comments

Browse Source 
Signed-off-by: Paul Elliott <paul.elliott@arm.com>
This commit is contained in:
Paul Elliott 2024-02-24 10:57:22 +00:00
parent ba536dc1db
commit 9011dae0c1
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
tests/src/helpers.c
View File

@ -33,15 +33,14 @@ mbedtls_threading_mutex_t mbedtls_test_info_mutex;
/*----------------------------------------------------------------------------*/
/* Mbedtls Test Info accessors
*
* NOTE - there are two types of accessors here; the _internal functions, which
* are expected to be used from this module *only*. These do not attempt to lock
* the mbedtls_test_info_mutex, as they are designed to be called from within
* public functions which do lock the mutex first (if mutexes are enabled).
* The main reason for this is the need to set some sets of test data
* atomically, without releasing the mutex inbetween to prevent race conditions
* resulting in mixed test info. The other public accessors have prototypes in
* the header and have to lock the mutex for safety as we obviously cannot
* control where they are called from. */
* NOTE - there are two types of accessors here: public accessors and internal
* accessors. The public accessors have prototypes in helpers.h and lock
* mbedtls_test_info_mutex (if mutexes are enabled). The _internal accessors,
* which are expected to be used from this module *only*, do not lock the mutex.
* These are designed to be called from within public functions which already
* hold the mutex. The main reason for this difference is the need to set
* multiple test data values atomically (without releasing the mutex) to prevent
* race conditions. */
mbedtls_test_result_t mbedtls_test_get_result(void)
{

4
tests/src/threading_helpers.c
View File

@ -321,8 +321,8 @@ void mbedtls_test_mutex_usage_check(void)
if (live_mutexes != 0) {
/* A positive number (more init than free) means that a mutex resource
* is leaking (on platforms where a mutex consumes more than the
* mbedtls_threading_mutex_t object itself). The rare case of a
* negative number means a missing init somewhere. */
* mbedtls_threading_mutex_t object itself). The (hopefully) rare
* case of a negative number means a missing init somewhere. */
mbedtls_fprintf(stdout, "[mutex: %d leaked] ", live_mutexes);
live_mutexes = 0;
mbedtls_test_set_mutex_usage_error("missing free");