[rtems commit] thread-API: Add rtems_*mutex_try_lock

[Christian Mauderer]

Module:    rtems
Branch:    master
Commit:    156896526f0579b5021e90f026286c62c2340efb
Changeset: http://git.rtems.org/rtems/commit/?id=156896526f0579b5021e90f026286c62c2340efb

Author:    Christian Mauderer <christian.mauderer at embedded-brains.de>
Date:      Wed May 26 11:26:59 2021 +0200

thread-API: Add rtems_*mutex_try_lock

This adds a rtems_mutex_try_lock and a rtems_recursive_mutex_try_lock.

Update #4440.

---

 cpukit/include/rtems/thread.h        | 12 ++++++
 testsuites/sptests/spthread01/init.c | 79 ++++++++++++++++++++++++++++++++++++
 2 files changed, 91 insertions(+)

diff --git a/cpukit/include/rtems/thread.h b/cpukit/include/rtems/thread.h
index feee612..d0cb03c 100644
--- a/cpukit/include/rtems/thread.h
+++ b/cpukit/include/rtems/thread.h
@@ -54,6 +54,11 @@ static __inline void rtems_mutex_lock( rtems_mutex *mutex )
   _Mutex_Acquire( mutex );
 }
 
+static __inline int rtems_mutex_try_lock( rtems_mutex *mutex )
+{
+  return _Mutex_Try_acquire( mutex );
+}
+
 static __inline void rtems_mutex_unlock( rtems_mutex *mutex )
 {
   _Mutex_Release( mutex );
@@ -97,6 +102,13 @@ static __inline void rtems_recursive_mutex_lock(
   _Mutex_recursive_Acquire( mutex );
 }
 
+static __inline int rtems_recursive_mutex_try_lock(
+  rtems_recursive_mutex *mutex
+)
+{
+  return _Mutex_recursive_Try_acquire( mutex );
+}
+
 static __inline void rtems_recursive_mutex_unlock(
   rtems_recursive_mutex *mutex
 )
diff --git a/testsuites/sptests/spthread01/init.c b/testsuites/sptests/spthread01/init.c
index 4c5bfc1..9044ca2 100644
--- a/testsuites/sptests/spthread01/init.c
+++ b/testsuites/sptests/spthread01/init.c
@@ -25,10 +25,74 @@
 
 const char rtems_test_name[] = "SPTHREAD 1";
 
+#define WAKEUP_EVENT RTEMS_EVENT_0
+
+typedef struct {
+  rtems_mutex *mtx;
+  rtems_recursive_mutex *rmtx;
+  rtems_id calling_task;
+} mutex_context;
+
+static void mutex_task(rtems_task_argument arg)
+{
+  mutex_context *m;
+  int rv;
+
+  m = (mutex_context *) arg;
+
+  rtems_test_assert(m->mtx != NULL || m->rmtx != NULL);
+
+  if (m->mtx) {
+    rv = rtems_mutex_try_lock(m->mtx);
+    rtems_test_assert(rv == EBUSY);
+  }
+
+  if (m->rmtx) {
+    rv = rtems_recursive_mutex_try_lock(m->rmtx);
+    rtems_test_assert(rv == EBUSY);
+  }
+
+  rtems_event_send(m->calling_task, WAKEUP_EVENT);
+}
+
+static void test_try_lock_from_different_task(
+  rtems_mutex *m,
+  rtems_recursive_mutex *r
+)
+{
+  mutex_context ctx;
+  rtems_status_code sc;
+  rtems_event_set e;
+  rtems_id id;
+
+  ctx.mtx = m;
+  ctx.rmtx = r;
+  ctx.calling_task = rtems_task_self();
+
+  sc = rtems_task_create(
+    rtems_build_name('M', 'T', 'X', ' '),
+    2,
+    RTEMS_MINIMUM_STACK_SIZE,
+    RTEMS_DEFAULT_MODES,
+    RTEMS_DEFAULT_ATTRIBUTES,
+    &id
+  );
+  rtems_test_assert(sc == RTEMS_SUCCESSFUL);
+
+  sc = rtems_task_start(id, mutex_task, (rtems_task_argument) &ctx);
+  rtems_test_assert(sc == RTEMS_SUCCESSFUL);
+
+  sc = rtems_event_receive(WAKEUP_EVENT, RTEMS_EVENT_ANY | RTEMS_WAIT, 10, &e);
+  rtems_test_assert(sc == RTEMS_SUCCESSFUL);
+
+  rtems_task_delete(id);
+}
+
 static void test_mutex(void)
 {
   rtems_mutex a = RTEMS_MUTEX_INITIALIZER("a");
   const char *name;
+  int rv;
 
   name = rtems_mutex_get_name(&a);
   rtems_test_assert(strcmp(name, "a") == 0);
@@ -47,6 +111,13 @@ static void test_mutex(void)
 
   rtems_mutex_lock(&a);
 
+  test_try_lock_from_different_task(&a, NULL);
+
+  rtems_mutex_unlock(&a);
+
+  rv = rtems_mutex_try_lock(&a);
+  rtems_test_assert(rv == 0);
+
   rtems_mutex_unlock(&a);
 
   rtems_mutex_destroy(&a);
@@ -56,6 +127,7 @@ static void test_recursive_mutex(void)
 {
   rtems_recursive_mutex a = RTEMS_RECURSIVE_MUTEX_INITIALIZER("a");
   const char *name;
+  int rv;
 
   name = rtems_recursive_mutex_get_name(&a);
   rtems_test_assert(strcmp(name, "a") == 0);
@@ -76,6 +148,13 @@ static void test_recursive_mutex(void)
 
   rtems_recursive_mutex_lock(&a);
 
+  rv = rtems_recursive_mutex_try_lock(&a);
+  rtems_test_assert(rv == 0);
+
+  test_try_lock_from_different_task(NULL, &a);
+
+  rtems_recursive_mutex_unlock(&a);
+
   rtems_recursive_mutex_unlock(&a);
 
   rtems_recursive_mutex_unlock(&a);