From 102aea2ba834e584fc73ae308868187b9c102a39 Mon Sep 17 00:00:00 2001
From: Gilles Peskine <Gilles.Peskine@arm.com>
Date: Fri, 3 Nov 2023 18:05:38 +0100
Subject: [PATCH] Add metatests for mutex usage

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
---
 programs/test/metatest.c | 100 ++++++++++++++++++++++++++++++++++++++-
 tests/scripts/all.sh     |   2 +-
 2 files changed, 100 insertions(+), 2 deletions(-)

diff --git a/programs/test/metatest.c b/programs/test/metatest.c
index d3173f3d4..7e173ee27 100644
--- a/programs/test/metatest.c
+++ b/programs/test/metatest.c
@@ -13,10 +13,15 @@
 #include <mbedtls/platform.h>
 #include <mbedtls/platform_util.h>
 #include "test/helpers.h"
+#include "test/macros.h"
 
 #include <stdio.h>
 #include <string.h>
 
+#if defined(MBEDTLS_THREADING_C)
+#include <mbedtls/threading.h>
+#endif
+
 
 /* This is an external variable, so the compiler doesn't know that we're never
  * changing its value.
@@ -62,7 +67,7 @@ void null_pointer_call(const char *name)
 
 
 /****************************************************************/
-/* Sanitizers */
+/* Memory */
 /****************************************************************/
 
 void read_after_free(const char *name)
@@ -104,6 +109,84 @@ void memory_leak(const char *name)
 }
 
 
+/****************************************************************/
+/* Threading */
+/****************************************************************/
+
+void mutex_lock_not_initialized(const char *name)
+{
+    (void) name;
+    /* Mutex usage verification is only done with pthread, not with other
+     * threading implementations. See tests/src/threading_helpers.c. */
+#if defined(MBEDTLS_THREADING_PTHREAD)
+    mbedtls_threading_mutex_t mutex;
+    memset(&mutex, 0, sizeof(mutex));
+    TEST_ASSERT(mbedtls_mutex_lock(&mutex) == 0);
+exit:
+    ;
+#endif
+}
+
+void mutex_unlock_not_initialized(const char *name)
+{
+    (void) name;
+    /* Mutex usage verification is only done with pthread, not with other
+     * threading implementations. See tests/src/threading_helpers.c. */
+#if defined(MBEDTLS_THREADING_C)
+    mbedtls_threading_mutex_t mutex;
+    memset(&mutex, 0, sizeof(mutex));
+    TEST_ASSERT(mbedtls_mutex_unlock(&mutex) == 0);
+exit:
+    ;
+#endif
+}
+
+void mutex_free_not_initialized(const char *name)
+{
+    (void) name;
+    /* Mutex usage verification is only done with pthread, not with other
+     * threading implementations. See tests/src/threading_helpers.c. */
+#if defined(MBEDTLS_THREADING_C)
+    mbedtls_threading_mutex_t mutex;
+    memset(&mutex, 0, sizeof(mutex));
+    mbedtls_mutex_free(&mutex);
+#endif
+}
+
+void mutex_double_init(const char *name)
+{
+    (void) name;
+#if defined(MBEDTLS_THREADING_C)
+    mbedtls_threading_mutex_t mutex;
+    mbedtls_mutex_init(&mutex);
+    mbedtls_mutex_init(&mutex);
+    mbedtls_mutex_free(&mutex);
+#endif
+}
+
+void mutex_double_free(const char *name)
+{
+    (void) name;
+#if defined(MBEDTLS_THREADING_C)
+    mbedtls_threading_mutex_t mutex;
+    mbedtls_mutex_init(&mutex);
+    mbedtls_mutex_free(&mutex);
+    mbedtls_mutex_free(&mutex);
+#endif
+}
+
+void mutex_leak(const char *name)
+{
+    (void) name;
+    /* Mutex usage verification is only done with pthread, not with other
+     * threading implementations. See tests/src/threading_helpers.c. */
+#if defined(MBEDTLS_THREADING_PTHREAD)
+    mbedtls_threading_mutex_t mutex;
+    mbedtls_mutex_init(&mutex);
+#endif
+}
+
+
 /****************************************************************/
 /* Command line entry point */
 /****************************************************************/
@@ -122,6 +205,14 @@ metatest_t metatests[] = {
     { "double_free", "asan", double_free },
     { "read_uninitialized_stack", "msan", read_uninitialized_stack },
     { "memory_leak", "asan", memory_leak },
+    /* Mutex usage verification is only done with pthread, not with other
+     * threading implementations. See tests/src/threading_helpers.c. */
+    { "mutex_lock_not_initialized", "pthread", mutex_lock_not_initialized },
+    { "mutex_unlock_not_initialized", "pthread", mutex_unlock_not_initialized },
+    { "mutex_free_not_initialized", "pthread", mutex_free_not_initialized },
+    { "mutex_double_init", "pthread", mutex_double_init },
+    { "mutex_double_free", "pthread", mutex_double_free },
+    { "mutex_leak", "pthread", mutex_leak },
     { NULL, NULL, NULL }
 };
 
@@ -157,10 +248,17 @@ int main(int argc, char *argv[])
         mbedtls_exit(MBEDTLS_EXIT_SUCCESS);
     }
 
+#if defined(MBEDTLS_TEST_MUTEX_USAGE)
+    mbedtls_test_mutex_usage_init();
+#endif
+
     for (const metatest_t *p = metatests; p->name != NULL; p++) {
         if (strcmp(argv[1], p->name) == 0) {
             mbedtls_printf("Running metatest %s...\n", argv[1]);
             p->entry_point(argv[1]);
+#if defined(MBEDTLS_TEST_MUTEX_USAGE)
+            mbedtls_test_mutex_usage_check();
+#endif
             mbedtls_printf("Running metatest %s... done, result=%d\n",
                            argv[1], (int) mbedtls_test_info.result);
             mbedtls_exit(mbedtls_test_info.result == MBEDTLS_TEST_RESULT_SUCCESS ?
diff --git a/tests/scripts/all.sh b/tests/scripts/all.sh
index 5f5d2fd23..04626c39f 100755
--- a/tests/scripts/all.sh
+++ b/tests/scripts/all.sh
@@ -1925,7 +1925,7 @@ component_test_full_cmake_clang () {
     programs/test/cpp_dummy_build
 
     msg "test: metatests (clang)"
-    tests/scripts/run-metatests.sh any
+    tests/scripts/run-metatests.sh any pthread
 
     msg "program demos (full config, clang)" # ~10s
     tests/scripts/run_demos.py