Kernel mode test harness

CMakeLists.txt

@@ -17,6 +17,7 @@ if("${Boost_VERSION}" VERSION_LESS "${VCLIBS_MIN_BOOST_VERSION}")
 endif()
 
 option(BUILD_TESTING "Enable testing" ON)
+option(STL_IS_KERNEL "Enable kernel testing" OFF)
 set(VCLIBS_SUFFIX "_oss" CACHE STRING "suffix for built DLL names to avoid conflicts with distributed DLLs")
 
 if(NOT DEFINED VCLIBS_TARGET_ARCHITECTURE)

azure-devops/cmake-configure-build.yml

@@ -38,7 +38,11 @@ steps:
     -DCMAKE_CXX_COMPILER=cl ^
     -DCMAKE_BUILD_TYPE=Release ^
     -DLIT_FLAGS=$(litFlags) ^
-    -DCMAKE_CXX_FLAGS=/analyze:autolog- ^
+    -DCMAKE_CXX_FLAGS="/analyze:autolog-" ^
+    -DSTL_IS_KERNEL=ON ^
+    -DWDK_INCLUDE_DIRECTORY="C:/Program Files (x86)/Windows Kits/10/Include/10.0.19041.0" ^
+    -DWDK_LIB_DIRECTORY="C:/Program Files (x86)/Windows Kits/10/Lib/10.0.19041.0" ^
+    -DWDK_BIN_DIRECTORY="C:/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0" ^
     -S $(Build.SourcesDirectory) -B $(${{ parameters.buildOutputLocationVar }})
   displayName: 'Configure the STL'
   timeoutInMinutes: 2

azure-devops/cross-build.yml

@@ -21,7 +21,7 @@ jobs:
     fixedFlags: '--timeout=240;--shuffle'
     parallelismFlag: '-j$(testParallelism)'
     xmlOutputFlag: '--xunit-xml-output=$(${{ parameters.buildOutputLocationVar }})/test-results.xml'
-    shardFlags: '--num-shards=$(System.TotalJobsInPhase);--run-shard=$(System.JobPositionInPhase)'
+    shardFlags: '-vv;--num-shards=$(System.TotalJobsInPhase);--run-shard=$(System.JobPositionInPhase)'
     litFlags: '$(fixedFlags);$(parallelismFlag);$(xmlOutputFlag);$(shardFlags)'
   strategy:
     parallel: ${{ parameters.numShards }}

azure-devops/native-build-test.yml

@@ -18,7 +18,7 @@ jobs:
     fixedFlags: '--timeout=240;--shuffle'
     parallelismFlag: '-j$(testParallelism)'
     xmlOutputFlag: '--xunit-xml-output=$(${{ parameters.buildOutputLocationVar }})/test-results.xml'
-    shardFlags: '--num-shards=$(System.TotalJobsInPhase);--run-shard=$(System.JobPositionInPhase)'
+    shardFlags: '-vv;--num-shards=$(System.TotalJobsInPhase);--run-shard=$(System.JobPositionInPhase)'
     litFlags: '$(fixedFlags);$(parallelismFlag);$(xmlOutputFlag);$(shardFlags)'
   strategy:
     parallel: ${{ parameters.numShards }}

tests/CMakeLists.txt

@@ -17,6 +17,9 @@ option(TESTS_BUILD_ONLY "Only run the build steps of tests" OFF)
 add_subdirectory(libcxx)
 add_subdirectory(std)
 add_subdirectory(tr1)
+if(STL_IS_KERNEL)
+    add_subdirectory(utils/kernel)
+endif()
 
 # Add the stl-lit subdirectory last so all the test directories have had a
 # chance to add to the config map and test directory global properties.

tests/libcxx/lit.site.cfg.in

@@ -32,6 +32,13 @@ lit_config.cxx_runtime = '@CMAKE_RUNTIME_OUTPUT_DIRECTORY@'
 lit_config.target_arch = '@VCLIBS_TARGET_ARCHITECTURE@'
 lit_config.build_only  = '@TESTS_BUILD_ONLY@'.lower() in ['1', 'true', 'on']
 
+lit_config.is_kernel = '@STL_IS_KERNEL@'.lower() in ['1', 'true', 'on']
+if lit_config.is_kernel:
+    lit_config.wdk_include = "@WDK_INCLUDE_DIRECTORY@"
+    lit_config.wdk_lib     = "@WDK_LIB_DIRECTORY@"
+    lit_config.wdk_bin     = "@WDK_BIN_DIRECTORY@"
+    lit_config.utils_dir   = "@STL_TEST_UTILS_DIR@"
+
 # Add parameters and features to the config
 stl.test.config.configure(
     stl.test.params.getDefaultParameters(config, lit_config),

tests/std/lit.site.cfg.in

@@ -32,6 +32,13 @@ lit_config.cxx_runtime = '@CMAKE_RUNTIME_OUTPUT_DIRECTORY@'
 lit_config.target_arch = '@VCLIBS_TARGET_ARCHITECTURE@'
 lit_config.build_only  = '@TESTS_BUILD_ONLY@'.lower() in ['1', 'true', 'on']
 
+lit_config.is_kernel = '@STL_IS_KERNEL@'.lower() in ['1', 'true', 'on']
+if lit_config.is_kernel:
+    lit_config.wdk_include = "@WDK_INCLUDE_DIRECTORY@"
+    lit_config.wdk_lib     = "@WDK_LIB_DIRECTORY@"
+    lit_config.wdk_bin     = "@WDK_BIN_DIRECTORY@"
+    lit_config.utils_dir   = "@STL_TEST_UTILS_DIR@"
+
 # Add parameters and features to the config
 stl.test.config.configure(
     stl.test.params.getDefaultParameters(config, lit_config),

tests/std/tests/Dev11_0863628_atomic_compare_exchange/env.lst

@@ -2,3 +2,4 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
 RUNALL_INCLUDE ..\impure_matrix.lst
+RUNALL_INCLUDE ..\kernel.lst

tests/std/tests/Dev11_0863628_atomic_compare_exchange/test.cpp

@@ -15,7 +15,6 @@
 #include <string.h>
 #include <type_traits>
 
-
 using namespace std;
 
 #define STATIC_ASSERT(...) static_assert(__VA_ARGS__, #__VA_ARGS__)
@@ -503,12 +502,25 @@ void test_layout_paranoia() {
     assert(b[2] == 3);
 }
 
+#ifdef _KERNEL_MODE
+
+#define assert_bitwise_identical(MSG, LHS, RHS)     \
+    {                                               \
+        double lhs = LHS;                           \
+        double rhs = RHS;                           \
+        if (memcmp(&lhs, &rhs, sizeof(lhs)) != 0) { \
+            assert(!MSG);                           \
+        }                                           \
+    }
+
+#else // _KERNEL_MODE
 void assert_bitwise_identical(const char* const msg, const double lhs, const double rhs) {
     if (memcmp(&lhs, &rhs, sizeof(lhs)) != 0) {
         printf("counterexample found in %s: %a and %a\n", msg, lhs, rhs);
         abort();
     }
 }
+#endif // _KERNEL_MODE
 
 void test_double_identical_results() {
 #if _HAS_CXX20

tests/std/tests/kernel.lst

@@ -0,0 +1,4 @@
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+PM_CL="/kernel /Zc:preprocessor /std:c++latest /w14640 /Zc:threadSafeInit- /DNO_TEST_ENVIRONMENT_PREPARER" PM_LINK="/IGNORE:4210 /subsystem:native /nodefaultlib stl_kernel.lib BufferOverflowFastFailK.lib ntoskrnl.lib hal.lib wmilib.lib Ntstrsafe.lib libcpmt.lib libcmt.lib"

tests/tr1/lit.site.cfg.in

@@ -31,6 +31,13 @@ lit_config.cxx_runtime = '@CMAKE_RUNTIME_OUTPUT_DIRECTORY@'
 lit_config.target_arch = '@VCLIBS_TARGET_ARCHITECTURE@'
 lit_config.build_only  = '@TESTS_BUILD_ONLY@'.lower() in ['1', 'true', 'on']
 
+lit_config.is_kernel = '@STL_IS_KERNEL@'.lower() in ['1', 'true', 'on']
+if lit_config.is_kernel:
+    lit_config.wdk_include = "@WDK_INCLUDE_DIRECTORY@"
+    lit_config.wdk_lib     = "@WDK_LIB_DIRECTORY@"
+    lit_config.wdk_bin     = "@WDK_BIN_DIRECTORY@"
+    lit_config.utils_dir   = "@STL_TEST_UTILS_DIR@"
+
 # Add parameters and features to the config
 stl.test.config.configure(
     stl.test.params.getDefaultParameters(config, lit_config),

tests/utils/kernel/CMakeLists.txt

@@ -0,0 +1,52 @@
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+set(STL_KERNEL_LOADER_SOURCES
+    ${CMAKE_CURRENT_LIST_DIR}/src/stl_kernel_loader/testapp.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/stl_kernel_loader/install.cpp
+)
+
+set(STL_KERNEL_SOURCES
+    ${CMAKE_CURRENT_LIST_DIR}/src/stl_kernel/doAssert.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/stl_kernel/stl_kernel.cpp
+)
+
+add_library(stl_kernel STATIC ${STL_KERNEL_SOURCES})
+set_target_properties(stl_kernel PROPERTIES LINKER_LANGUAGE CXX)
+target_compile_definitions(stl_kernel PRIVATE "__STL_IS_KERNEL")
+
+# ${WDK_INCLUDE_DIRECTORY}/km/crt isn't in the files under test include paths.
+# doAssert.cpp wants to use RtlStringCbPrintfExA, and that requires pulling in
+# km/crt.  If we don't pull in km/crt here, we erroneously pull in user mode
+# crt headers, and that gets us linker errors dealing with missing user mode
+# symbols in this kernel mode binary.
+target_include_directories(stl_kernel PRIVATE
+    ${CMAKE_CURRENT_LIST_DIR}/inc
+    ${WDK_INCLUDE_DIRECTORY}/km
+    ${WDK_INCLUDE_DIRECTORY}/km/crt
+    ${WDK_INCLUDE_DIRECTORY}/shared
+)
+
+# TRANSITION, WDK needs to suppress C5040
+if(VCLIBS_TARGET_ARCHITECTURE STREQUAL "x86")
+    set(STL_KERNEL_CALLING_CONVENTION "/Gz")
+else()
+    set(STL_KERNEL_CALLING_CONVENTION "")
+endif()
+
+target_compile_options(stl_kernel PRIVATE /kernel /wd5040 ${STL_KERNEL_CALLING_CONVENTION})
+
+add_executable(stl_kernel_loader ${STL_KERNEL_LOADER_SOURCES})
+target_include_directories(stl_kernel_loader PRIVATE
+    ${CMAKE_CURRENT_LIST_DIR}/inc
+    ${WDK_INCLUDE_DIRECTORY}/ucrt
+    ${WDK_INCLUDE_DIRECTORY}/um
+    ${WDK_INCLUDE_DIRECTORY}/shared
+)
+target_compile_options(stl_kernel_loader PRIVATE /EHsc)
+target_link_libraries(stl_kernel_loader PRIVATE
+    msvcrt.lib
+    kernel32.lib
+    ucrt.lib
+    AdvApi32.lib
+)

tests/utils/kernel/generateMsvcCert.ps1

@@ -0,0 +1,30 @@
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+param([string]$out="MsvcStlTestingCert.pfx",[string]$pass="placeholderPassword")
+
+$ErrorActionPreference = 'Stop'
+
+$currentIdentity = ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent())
+#$isAdmin = $currentIdentity.IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator")
+#if (!$isAdmin) {
+#        $name = [Security.Principal.WindowsIdentity]::GetCurrent().Name
+#        Throw "The current prompt is not an elevated administrator prompt!  Running as $name"
+#}
+
+# , cert:\localmachine\root, cert:\localmachine\trustedpublisher |
+# Clean up old certificates
+Get-ChildItem cert:\currentUser\My
+Where-Object { $_.Subject -eq 'CN=MsvcStlTestingCert' } |
+Remove-Item
+
+# Make the new cert
+$cert = New-SelfSignedCertificate -Type CodeSigningCert -DnsName "MsvcStlTestingCert" `
+        -certstorelocation cert:\currentUser\my -NotAfter (Get-Date).AddDays(2)
+$path = 'cert:\currentUser\my\' + $cert.thumbprint
+$pwd = ConvertTo-SecureString -String $pass -Force -AsPlainText
+Export-PfxCertificate -cert $path -FilePath $out -Password $pwd
+
+# install the cert so that we can load our drivers
+# Import-PfxCertificate -FilePath $out -CertStoreLocation cert:\localmachine\root -Password $pwd
+# Import-PfxCertificate -FilePath $out -CertStoreLocation cert:\localmachine\trustedpublisher -Password $pwd

tests/utils/kernel/inc/assert.h

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#include <cassert>

tests/utils/kernel/inc/cassert

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern int* g_test_failures;
+extern char* g_output_buffer;
+extern size_t g_space_available;
+void doAssert(const char* file, int line, const char* expr);
+
+#undef assert
+#define assert(x)                         \
+    if (!(x)) {                           \
+        doAssert(__FILE__, __LINE__, #x); \
+    }
+
+#ifdef __cplusplus
+}
+#endif

tests/utils/kernel/inc/stl_kernel/kernel_test_constants.h

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+// This header is intended to be force included into the .cpp under test.
+// KERNEL_TEST_NAME will then be provided as a /D switch and preprocessor
+// concatenated into one big string literal.
+extern const wchar_t* const STL_KERNEL_NT_DEVICE_NAME  = L"\\Device\\" KERNEL_TEST_NAME;
+extern const wchar_t* const STL_KERNEL_DOS_DEVICE_NAME = L"\\DosDevices\\" KERNEL_TEST_NAME;

tests/utils/kernel/inc/stl_kernel/stl_kernel.h

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#pragma once
+
+#ifdef __STL_IS_KERNEL
+#include <ntddk.h>
+#else
+#include <winioctl.h>
+#endif
+
+#define IOCTL_SIOCTL_METHOD_RUN_TEST CTL_CODE(40000, 0x800, METHOD_BUFFERED, FILE_ANY_ACCESS)
+
+struct TestResults {
+    int main_return;
+    int tests_failed;
+    // arbitrary buffer size, chosen to make the structure a "round" 4K
+    char output[4088];
+};

tests/utils/kernel/src/stl_kernel/doAssert.cpp

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#include "test_decls.h"
+#include <Ntstrsafe.h>
+#include <ntddk.h>
+
+KGUARDED_MUTEX g_assert_mutex;
+extern "C" {
+int* g_test_failures;
+char* g_output_buffer;
+size_t g_space_available;
+}
+
+static const char ASSERTION_FAILED[]     = "assertion failed ";
+static const size_t ASSERTION_FAILED_LEN = sizeof(ASSERTION_FAILED) - 1;
+extern "C" void doAssert(const char* file, int line, const char* expr) {
+    KeAcquireGuardedMutex(&g_assert_mutex);
+    ++(*g_test_failures);
+
+    RtlStringCbPrintfExA(g_output_buffer, g_space_available, &g_output_buffer, &g_space_available,
+        0, // flags
+        "assertion failed %s(%d): %s\n", file, line, expr);
+
+    KeReleaseGuardedMutex(&g_assert_mutex);
+}