add tests for ThreadPool

Author: Vlada Kanivets

include/kf/ThreadPool.h

@@ -11,7 +11,7 @@ namespace kf
         {
         }
 
-        ThreadPool(ThreadPool&&) = default;
+        ThreadPool(ThreadPool&& other) = default;
 
         ~ThreadPool()
         {
@@ -53,7 +53,7 @@ namespace kf
         }
 
     private:
-        Thread m_threads[kMaxCount];
+        Thread m_threads[kMaxCount]{};
         int m_count;
     };
 }

test/CMakeLists.txt

@@ -59,6 +59,7 @@ wdk_add_driver(kf-test WINVER NTDDI_WIN10 STL
     AutoSpinLockTest.cpp
     EResourceSharedLockTest.cpp
     RecursiveAutoSpinLockTest.cpp
+    ThreadPoolTest.cpp
 )
 
 target_link_libraries(kf-test kf::kf kmtest::kmtest)

test/ThreadPoolTest.cpp

@@ -0,0 +1,120 @@
+#include "pch.h"
+#include <kf/ThreadPool.h>
+
+SCENARIO("kf::ThreadPool")
+{
+    struct TestObject
+    {
+        NTSTATUS run()
+        {
+            InterlockedIncrement(&value);
+            return STATUS_SUCCESS;
+        }
+
+        LONG value = 0;
+    };
+
+    constexpr auto fn = [](void* context) {
+        LARGE_INTEGER interval;
+        interval.QuadPart = -10'000; 
+        KeDelayExecutionThread(KernelMode, FALSE, &interval);
+        auto p = static_cast<LONG*>(context);
+        InterlockedIncrement(p);
+        };
+
+    GIVEN("A ThreadPool with count <= kMaxCount")
+    {
+        kf::ThreadPool pool(4);
+
+        WHEN("Starting threads with a lambda")
+        {
+            LONG value = 0;
+            NTSTATUS status = pool.start(fn, &value);
+
+            THEN("Status is successful")
+            {
+                REQUIRE(NT_SUCCESS(status));
+            }
+
+            pool.join();
+
+            THEN("All threads incremented the value")
+            {
+                REQUIRE(value == 4);
+            }
+        }
+
+        WHEN("Starting threads with a member function")
+        {
+            TestObject obj;
+            NTSTATUS status = pool.start<&TestObject::run>(&obj);
+
+            THEN("Status is successful")
+            {
+                REQUIRE(NT_SUCCESS(status));
+            }
+
+            pool.join();
+
+            THEN("All threads executed the member routine")
+            {
+                REQUIRE(obj.value == 4);
+            }
+        }
+    }
+
+    GIVEN("A ThreadPool with count > kMaxCount")
+    {
+        kf::ThreadPool pool(100);
+        LONG value = 0;
+
+        WHEN("Starting threads")
+        {
+            REQUIRE_NT_SUCCESS(pool.start(fn, &value));
+
+            pool.join();
+
+            THEN("ThreadPool started up to kMaxCount threads")
+            {
+                REQUIRE(value == 64);
+            }
+        }
+    }
+
+    GIVEN("A ThreadPool with 4 threads")
+    {
+        LONG value = 0;
+
+        WHEN("ThreadPool with started threads goes out of scope")
+        {
+            {
+                kf::ThreadPool pool(4);
+                REQUIRE_NT_SUCCESS(pool.start(fn, &value));
+            }
+
+            THEN("All threads are complete successfully")
+            {
+                REQUIRE(value == 4);
+            }
+        }
+    }
+
+    GIVEN("ThreadPool with 4 started threads")
+    {
+        LONG value = 0;
+        kf::ThreadPool pool1(4);
+
+        REQUIRE_NT_SUCCESS(pool1.start(fn, &value));
+
+        WHEN("ThreadPool moved into another pool")
+        {
+            kf::ThreadPool pool2(std::move(pool1));
+            pool2.join();
+
+            THEN("Threads still run and complete successfully")
+            {
+                REQUIRE(value == 4);
+            }
+        }
+    }
+}

test/pch.h

@@ -21,6 +21,42 @@ extern "C" inline int _CrtDbgReport(
     KeBugCheckEx(KERNEL_SECURITY_CHECK_FAILURE, 0, 0, 0, 0);
 }
 
+inline void __ehvec_dtor(
+    void* ptr,
+    unsigned __int64 size,
+    unsigned __int64 count,
+    void(__cdecl* dtor)(void*)
+)
+{
+    UNREFERENCED_PARAMETER(ptr);
+    UNREFERENCED_PARAMETER(size);
+    UNREFERENCED_PARAMETER(count);
+    UNREFERENCED_PARAMETER(dtor);
+}
+
+inline void __cdecl __ehvec_copy_ctor(
+    void* dst,
+    void* src,
+    unsigned __int64 size,
+    unsigned __int64 count,
+    void(__cdecl* copy_ctor)(void*, void*),
+    void(__cdecl* dtor)(void*)
+)
+{
+    UNREFERENCED_PARAMETER(dtor);
+
+    auto d = static_cast<unsigned char*>(dst);
+    auto s = static_cast<unsigned char*>(src);
+
+    for (unsigned __int64 i = 0; i < count; ++i)
+    {
+        copy_ctor(d, s);
+        d += size;
+        s += size;
+    }
+}
+
+
 namespace std
 {
     [[noreturn]] inline void __cdecl _Xinvalid_argument(_In_z_ const char* /*What*/)