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 }}

stl/inc/ranges

@@ -2489,6 +2489,49 @@ namespace ranges {
         };
 
         inline constexpr _Drop_fn drop;
+
+        // VARIABLE views::counted
+        class _Counted_fn {
+        private:
+            enum class _St { _Span, _Subrange, _Subrange_counted };
+
+            template <class _It>
+            _NODISCARD static _CONSTEVAL _Choice_t<_St> _Choose() noexcept {
+                _STL_INTERNAL_STATIC_ASSERT(input_or_output_iterator<_It>);
+                if constexpr (contiguous_iterator<_It>) {
+                    return {_St::_Span, noexcept(span{_STD to_address(_STD declval<_It>()), iter_difference_t<_It>{}})};
+                } else if constexpr (random_access_iterator<_It>) {
+                    return {_St::_Subrange,
+                        noexcept(subrange{_STD declval<_It>(), _STD declval<_It>() + iter_difference_t<_It>{}})};
+                } else {
+                    return {_St::_Subrange_counted,
+                        noexcept(subrange{
+                            counted_iterator{_STD declval<_It>(), iter_difference_t<_It>{}}, default_sentinel})};
+                }
+            }
+
+            template <class _It>
+            static constexpr _Choice_t<_St> _Choice = _Choose<_It>();
+
+        public:
+            // clang-format off
+            template <class _It>
+                requires input_or_output_iterator<decay_t<_It>>
+            _NODISCARD constexpr auto operator()(_It&& _First, const iter_difference_t<decay_t<_It>> _Count) const
+                noexcept(_Choice<decay_t<_It>>._No_throw) {
+                // clang-format on
+                _STL_ASSERT(_Count >= 0, "The size passed to views::counted must be non-negative");
+                if constexpr (_Choice<decay_t<_It>>._Strategy == _St::_Span) {
+                    return span{_STD to_address(_STD forward<_It>(_First)), static_cast<size_t>(_Count)};
+                } else if constexpr (_Choice<decay_t<_It>>._Strategy == _St::_Subrange) {
+                    return subrange{_First, _First + _Count};
+                } else if constexpr (_Choice<decay_t<_It>>._Strategy == _St::_Subrange_counted) {
+                    return subrange{counted_iterator{_STD forward<_It>(_First), _Count}, default_sentinel};
+                }
+            }
+        };
+
+        inline constexpr _Counted_fn counted;
     } // namespace views
 
     // CLASS TEMPLATE ranges::drop_while_view
@@ -4088,6 +4131,116 @@ namespace ranges {
         inline constexpr auto keys   = elements<0>;
         inline constexpr auto values = elements<1>;
     } // namespace views
+
+    // CLASS TEMPLATE ranges::common_view
+    // clang-format off
+    template <view _Vw>
+        requires (!common_range<_Vw> && copyable<iterator_t<_Vw>>)
+    class common_view : public view_interface<common_view<_Vw>> {
+        // clang-format on
+    private:
+        /* [[no_unique_address]] */ _Vw _Base{};
+
+    public:
+        common_view() = default;
+        constexpr explicit common_view(_Vw _Base_) noexcept(is_nothrow_move_constructible_v<_Vw>) // strengthened
+            : _Base(_STD move(_Base_)) {}
+        // converting constructor template omitted per LWG-3405
+
+        _NODISCARD constexpr _Vw base() const& noexcept(
+            is_nothrow_copy_constructible_v<_Vw>) /* strengthened */ requires copy_constructible<_Vw> {
+            return _Base;
+        }
+        _NODISCARD constexpr _Vw base() && noexcept(is_nothrow_move_constructible_v<_Vw>) /* strengthened */ {
+            return _STD move(_Base);
+        }
+
+        _NODISCARD constexpr auto begin() noexcept(
+            noexcept(_RANGES begin(_Base)) && is_nothrow_move_constructible_v<iterator_t<_Vw>>) /* strengthened */ {
+            if constexpr (random_access_range<_Vw> && sized_range<_Vw>) {
+                return _RANGES begin(_Base);
+            } else {
+                return common_iterator<iterator_t<_Vw>, sentinel_t<_Vw>>{_RANGES begin(_Base)};
+            }
+        }
+
+        _NODISCARD constexpr auto begin() const noexcept(
+            noexcept(_RANGES begin(_Base))
+            && is_nothrow_move_constructible_v<iterator_t<const _Vw>>) /* strengthened */ requires range<const _Vw> {
+            if constexpr (random_access_range<const _Vw> && sized_range<const _Vw>) {
+                return _RANGES begin(_Base);
+            } else {
+                return common_iterator<iterator_t<const _Vw>, sentinel_t<const _Vw>>{_RANGES begin(_Base)};
+            }
+        }
+
+        _NODISCARD constexpr auto end() {
+            if constexpr (random_access_range<_Vw> && sized_range<_Vw>) {
+                return _RANGES begin(_Base) + _RANGES size(_Base);
+            } else {
+                return common_iterator<iterator_t<_Vw>, sentinel_t<_Vw>>{_RANGES end(_Base)};
+            }
+        }
+
+        _NODISCARD constexpr auto end() const requires range<const _Vw> {
+            if constexpr (random_access_range<const _Vw> && sized_range<const _Vw>) {
+                return _RANGES begin(_Base) + _RANGES size(_Base);
+            } else {
+                return common_iterator<iterator_t<const _Vw>, sentinel_t<const _Vw>>{_RANGES end(_Base)};
+            }
+        }
+
+        _NODISCARD constexpr auto size() noexcept(
+            noexcept(_RANGES size(_Base))) /* strengthened */ requires sized_range<_Vw> {
+            return _RANGES size(_Base);
+        }
+        _NODISCARD constexpr auto size() const
+            noexcept(noexcept(_RANGES size(_Base))) /* strengthened */ requires sized_range<const _Vw> {
+            return _RANGES size(_Base);
+        }
+    };
+
+    template <class _Rng>
+    common_view(_Rng &&) -> common_view<views::all_t<_Rng>>;
+
+    namespace views {
+        // VARIABLE views::common
+        class _Common_fn : public _Pipe::_Base<_Common_fn> {
+        private:
+            enum class _St { _None, _All, _Common };
+
+            template <class _Rng>
+            _NODISCARD static _CONSTEVAL _Choice_t<_St> _Choose() noexcept {
+                if constexpr (common_range<_Rng>) {
+                    return {_St::_All, noexcept(views::all(_STD declval<_Rng>()))};
+                } else if constexpr (copyable<iterator_t<_Rng>>) {
+                    return {_St::_Common, noexcept(common_view{_STD declval<_Rng>()})};
+                } else {
+                    return {_St::_None};
+                }
+            }
+
+            template <class _Rng>
+            static constexpr _Choice_t<_St> _Choice = _Choose<_Rng>();
+
+        public:
+            // clang-format off
+            template <viewable_range _Rng>
+                requires (_Choice<_Rng>._Strategy != _St::_None)
+            _NODISCARD constexpr auto operator()(_Rng&& _Range) const noexcept(_Choice<_Rng>._No_throw) {
+                // clang-format on
+                if constexpr (_Choice<_Rng>._Strategy == _St::_All) {
+                    return views::all(_STD forward<_Rng>(_Range));
+                } else if constexpr (_Choice<_Rng>._Strategy == _St::_Common) {
+                    return common_view{_STD forward<_Rng>(_Range)};
+                } else {
+                    static_assert(_Always_false<_Rng>, "Should be unreachable");
+                }
+            }
+        };
+
+        inline constexpr _Common_fn common;
+    } // namespace views
 } // namespace ranges
 
 namespace views = ranges::views;

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/P0896R4_views_common/test.cpp

@@ -357,6 +357,9 @@ constexpr bool test_one(Rng&& rng, Expected&& expected) {
         }
 
         // Validate common_view::base() && (NB: do this last since it leaves r moved-from)
+#if !defined(__clang__) && !defined(__EDG__) // TRANSITION, DevCom-1159442
+        (void) 42;
+#endif // TRANSITION, DevCom-1159442
         same_as<V> auto b2 = move(r).base();
         static_assert(noexcept(move(r).base()) == is_nothrow_move_constructible_v<V>);
         if (!is_empty) {

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,29 @@
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+param([string]$out="MsvcStlTestingCert.pfx",[string]$pass="placeholderPassword")
+
+$ErrorActionPreference = 'Stop'
+# Clean up old certificates
+Get-ChildItem cert:\localmachine\My |
+Where-Object { $_.Subject -eq 'CN=MsvcStlTestingCert' } |
+Remove-Item
+
+Get-ChildItem cert:\localmachine\root |
+Where-Object { $_.Subject -eq 'CN=MsvcStlTestingCert' } |
+Remove-Item
+
+Get-ChildItem cert:\localmachine\trustedpublisher |
+Where-Object { $_.Subject -eq 'CN=MsvcStlTestingCert' } |
+Remove-Item
+
+# Make the new cert
+$cert = New-SelfSignedCertificate -Type CodeSigningCert -DnsName "MsvcStlTestingCert" `
+        -certstorelocation cert:\localmachine\my -NotAfter (Get-Date).AddDays(2)
+$path = 'cert:\localMachine\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>