tests: add some pthread and std::thread unit tests

This patch adds some pthread and C++11 std::thread unit tests.

Change-Id: I9706b542e5fa927a87c6e8ae2a6330fab7bb5d72
Reviewed-on: https://gem5-review.googlesource.com/8221
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
Maintainer: Brandon Potter <Brandon.Potter@amd.com>

1 files changed, 133 insertions, 0 deletions

diff --git a/tests/test-progs/pthread/src/test_pthread_mutex.cpp b/tests/test-progs/pthread/src/test_pthread_mutex.cpp
new file mode 100644
index 000000000..9528a3607
--- /dev/null
+++ b/tests/test-progs/pthread/src/test_pthread_mutex.cpp
@@ -0,0 +1,133 @@
+/*
+  * Copyright (c) 2018, Cornell University
+  * All rights reserved.
+  *
+  * Redistribution and use in source and binary forms, with or
+  * without modification, are permitted provided that the following
+  * conditions are met:
+  *
+  * Redistributions of source code must retain the above copyright
+  * notice, this list of conditions and the following disclaimer.
+  *
+  * Redistributions in binary form must reproduce the above
+  * copyright notice, this list of conditions and the following
+  * disclaimer in the documentation and/or other materials provided
+  * with the distribution.
+  *
+  * Neither the name of Cornell University nor the names of its
+  * contributors may be used to endorse or promote products derived
+  * from this software without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+  * POSSIBILITY OF SUCH DAMAGE.
+  *
+  * Authors: Tuan Ta
+  */
+
+#include <pthread.h>
+
+#include <cstdlib>
+#include <iostream>
+
+//------------------------------------------------------------------------
+// Create n threads, run them in parallel and wait for them in the master
+// thread.
+// Each child thread increments a shared variable m times
+//------------------------------------------------------------------------
+
+#define MAX_N_WORKER_THREADS 10
+
+typedef struct
+{
+    int nsteps;
+    int* shared_var;
+    pthread_mutex_t* lock;
+} ThreadArg;
+
+void* func( void* args )
+{
+    ThreadArg* my_args = ( ThreadArg* ) args;
+
+    int nsteps = my_args->nsteps;
+    int* shared_var = my_args->shared_var;
+    pthread_mutex_t* lock = my_args->lock;
+
+    for ( int i = 0; i < nsteps; ++i ) {
+        // acquire the lock
+        pthread_mutex_lock(lock);
+
+        // increment the shared_var
+        (*shared_var)++;
+
+        // release the lock
+        pthread_mutex_unlock(lock);
+    }
+
+    return nullptr;
+}
+
+int main( int argc, const char* argv[] )
+{
+    int n_worker_threads = 0;
+
+    // allocate all threads
+    pthread_t* threads = new pthread_t[MAX_N_WORKER_THREADS];
+    ThreadArg* t_args = new ThreadArg[MAX_N_WORKER_THREADS];
+
+    // variable shared among all threads
+    int shared_var = 0;
+
+    // number of steps each thread increments the shared_var
+    int nsteps = 10000;
+
+    // create a shared lock
+    pthread_mutex_t lock;
+    pthread_mutex_init(&lock, NULL);
+
+    int ret;
+
+    // try to spawn as many worker threads as possible
+    for ( int tid = 0; tid < MAX_N_WORKER_THREADS; ++tid ) {
+        t_args[tid].nsteps = nsteps;
+        t_args[tid].shared_var = &shared_var;
+        t_args[tid].lock = &lock;
+
+        // spawn thread
+        ret = pthread_create( threads + tid, nullptr, func, &t_args[tid] );
+
+        if (ret != 0)
+            break;
+
+        n_worker_threads++;
+    }
+
+    // sync up all threads
+    for ( int tid = 0; tid < n_worker_threads; ++tid ) {
+        pthread_join( threads[tid], nullptr );
+    }
+
+    // verify
+    bool passed = true;
+    if ( shared_var != n_worker_threads * nsteps )
+        passed = false;
+
+    // clean up
+    delete[] threads;
+    delete[] t_args;
+
+    if (!passed || n_worker_threads < 1)
+        return EXIT_FAILURE;
+
+    return EXIT_SUCCESS;
+}