<vector>: Add ASan annotations.

stl/CMakeLists.txt

@@ -250,6 +250,7 @@ endforeach()
 
 # Objs that exist in both libcpmt[d][01].lib and msvcprt[d].lib.
 set(IMPLIB_SOURCES
+    ${CMAKE_CURRENT_LIST_DIR}/src/asan_noop.cpp
     ${CMAKE_CURRENT_LIST_DIR}/src/filesystem.cpp
     ${CMAKE_CURRENT_LIST_DIR}/src/format.cpp
     ${CMAKE_CURRENT_LIST_DIR}/src/locale0_implib.cpp
@@ -392,6 +393,10 @@ set(SOURCES
     ${CMAKE_CURRENT_LIST_DIR}/src/xwstoxfl.cpp
 )
 
+set(ASAN_SOURCES
+    ${CMAKE_CURRENT_LIST_DIR}/src/asan.cpp
+)
+
 set(EHA_SOURCES
     ${CMAKE_CURRENT_LIST_DIR}/src/excptptr.cpp
 )
@@ -543,11 +548,11 @@ add_stl_dlls("d" "_DEBUG" "${VCLIBS_DEBUG_OPTIONS}" "" "/opt:ref,noicf")
 
 function(add_stl_statics FLAVOR_SUFFIX THIS_CONFIG_DEFINITIONS THIS_CONFIG_COMPILE_OPTIONS)
     add_library(libcpmt${FLAVOR_SUFFIX}_eha OBJECT ${EHA_SOURCES})
-    target_compile_definitions(libcpmt${FLAVOR_SUFFIX}_eha PRIVATE "${THIS_CONFIG_DEFINITIONS}")
+    target_compile_definitions(libcpmt${FLAVOR_SUFFIX}_eha PRIVATE "${THIS_CONFIG_DEFINITIONS};_ANNOTATE_VECTOR")
     target_compile_options(libcpmt${FLAVOR_SUFFIX}_eha PRIVATE "${THIS_CONFIG_COMPILE_OPTIONS};/EHa")
 
     add_library(libcpmt${FLAVOR_SUFFIX} STATIC ${HEADERS} ${IMPLIB_SOURCES} ${SOURCES} ${INITIALIZER_SOURCES} ${STATIC_SOURCES})
-    target_compile_definitions(libcpmt${FLAVOR_SUFFIX} PRIVATE "${THIS_CONFIG_DEFINITIONS}")
+    target_compile_definitions(libcpmt${FLAVOR_SUFFIX} PRIVATE "${THIS_CONFIG_DEFINITIONS};_ANNOTATE_VECTOR")
     target_compile_options(libcpmt${FLAVOR_SUFFIX} PRIVATE "${THIS_CONFIG_COMPILE_OPTIONS};/EHsc")
     target_link_libraries(libcpmt${FLAVOR_SUFFIX} PRIVATE Boost::math libcpmt${FLAVOR_SUFFIX}_eha std_init_once_begin_initialize std_init_once_complete)
 endfunction()
@@ -557,3 +562,5 @@ add_stl_statics("1" "_ITERATOR_DEBUG_LEVEL=1" "${VCLIBS_RELEASE_OPTIONS}")
 add_stl_statics("d" "_DEBUG;_ITERATOR_DEBUG_LEVEL=2" "${VCLIBS_DEBUG_OPTIONS}")
 add_stl_statics("d1" "_DEBUG;_ITERATOR_DEBUG_LEVEL=1" "${VCLIBS_DEBUG_OPTIONS}")
 add_stl_statics("d0" "_DEBUG;_ITERATOR_DEBUG_LEVEL=0" "${VCLIBS_DEBUG_OPTIONS}")
+
+add_library(stl_asan STATIC ${ASAN_SOURCES})

stl/inc/xmemory

@@ -774,6 +774,9 @@ _NODISCARD constexpr allocation_result<typename allocator_traits<_Alloc>::pointe
 #endif // __cpp_lib_concepts
 #endif // _HAS_CXX23
 
+// The number of user bytes a single byte of ASAN shadow memory can track.
+_INLINE_VAR constexpr size_t _Asan_granularity = 8;
+
 template <class _Ty>
 class allocator {
 public:
@@ -857,6 +860,8 @@ public:
         return static_cast<size_t>(-1) / sizeof(_Ty);
     }
 #endif // _HAS_DEPRECATED_ALLOCATOR_MEMBERS
+
+    static constexpr size_t _Minimum_allocation_alignment = _Asan_granularity;
 };
 
 template <>

stl/msbuild/stl_asan/dirs.proj

@@ -0,0 +1,14 @@
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<!--
+Copyright (c) Microsoft Corporation.
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+-->
+
+    <Import Project="$(MSBuildThisFileDirectory)..\..\..\..\crt-common.settings.targets" />
+
+    <ItemGroup Condition="'$(BuildExePhase)' == '1'">
+        <ProjectFile Include="stl_asan.nativeproj" />
+    </ItemGroup>
+
+    <Import Project="$(_NTDRIVE)$(_NTROOT)\tools\Microsoft.DevDiv.Traversal.targets" />
+</Project>

stl/msbuild/stl_asan/stl_asan.files.settings.targets

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="Dogfood">
+<!--
+Copyright (c) Microsoft Corporation.
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+-->
+
+    <ItemGroup>
+        <BuildFiles Include="
+            $(CrtRoot)\github\stl\src\asan.cpp;
+            ">
+            <BuildAs>nativecpp</BuildAs>
+        </BuildFiles>
+    </ItemGroup>
+
+</Project>

stl/msbuild/stl_asan/stl_asan.nativeproj

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="Dogfood">
+<!--
+Copyright (c) Microsoft Corporation.
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+-->
+
+    <PropertyGroup>
+        <Arm64X>true</Arm64X>
+    </PropertyGroup>
+
+    <Import Project="$(MSBuildThisFileDirectory)stl_asan.settings.targets"/>
+
+</Project>

stl/msbuild/stl_asan/stl_asan.settings.targets

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="Dogfood">
+<!--
+Copyright (c) Microsoft Corporation.
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+-->
+
+    <PropertyGroup>
+        <FinalBinary>p_stl_asan</FinalBinary>
+        <TargetType>LIBRARY</TargetType>
+        <Arm64CombinedPdb>true</Arm64CombinedPdb>
+    </PropertyGroup>
+
+    <Import Project="$(MSBuildThisFileDirectory)..\..\..\..\crt_build.settings.targets"/>
+
+    <PropertyGroup>
+        <OutputName>stl_asan</OutputName>
+    </PropertyGroup>
+
+    <PropertyGroup>
+        <ClProgramDataBaseFileName>$(OutputLibPdbPath)$(OutputName)$(PdbVerName).pdb</ClProgramDataBaseFileName>
+    </PropertyGroup>
+
+    <Import Project="$(MSBuildThisFileDirectory)stl_asan.files.settings.targets"/>
+
+    <Import Project="$(VCToolsRootPath)\crt\crt_build.targets"/>
+    <Target Name="GetBaseAddress"/>
+
+</Project>

stl/msbuild/stl_base/libcp.settings.targets

@@ -27,7 +27,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
     <PropertyGroup>
         <ClProgramDataBaseFileName>$(OutputLibPdbPath)$(OutputName)$(PdbVerName).pdb</ClProgramDataBaseFileName>
         <ClDefines Condition="'$(DependsOnConcRT)' == 'true'">$(ClDefines);_STL_CONCRT_SUPPORT</ClDefines>
-        <ClDefines>$(ClDefines);_VCRT_ALLOW_INTERNALS</ClDefines>
+        <ClDefines>$(ClDefines);_VCRT_ALLOW_INTERNALS;_ANNOTATE_VECTOR</ClDefines>
     </PropertyGroup>
 
     <Import Project="$(MSBuildThisFileDirectory)\stl.files.settings.targets"/>

stl/msbuild/stl_base/stl.files.settings.targets

@@ -160,6 +160,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
         <!-- Objs that exist in both libcpmt[d][01].lib and msvcprt[d].lib
              (controlled by IncludeInLink and IncludeInImportLib). -->
         <BuildFiles Include="
+            $(CrtRoot)\github\stl\src\asan_noop.cpp;
             $(CrtRoot)\github\stl\src\filesystem.cpp;
             $(CrtRoot)\github\stl\src\format.cpp;
             $(CrtRoot)\github\stl\src\locale0_implib.cpp;

stl/src/asan.cpp

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+namespace std {
+    extern "C" {
+    extern const bool _Asan_vector_should_annotate = true;
+    }
+} // namespace std

stl/src/asan_noop.cpp

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+extern "C" {
+extern const bool _Asan_vector_should_annotate_default = false;
+
+void __cdecl __sanitizer_annotate_contiguous_container_default(
+    const void*, const void*, const void*, const void*) noexcept {}
+}

tests/std/test.lst

@@ -186,6 +186,7 @@ tests\GH_001638_dllexport_derived_classes
 tests\GH_001850_clog_tied_to_cout
 tests\GH_001858_iostream_exception
 tests\GH_001914_cached_position
+tests\GH_002030_asan_annotate_vector
 tests\GH_002039_byte_is_not_trivially_swappable
 tests\GH_002058_debug_iterator_race
 tests\GH_002120_streambuf_seekpos_and_seekoff

tests/std/tests/GH_002030_asan_annotate_vector/env.lst

@@ -0,0 +1,37 @@
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# This test matrix is the usual test matrix, with all currently unsupported options removed, crossed with the ASan flags.
+# TRANSITION, VSO-1350252
+# Due to a bug in the ASan libs using ASan with /MD or /MT requires IDL==0 and using /MDd or /MTd requires IDL==2.
+# clang-cl does not currently support targeting /MDd or /MTd.
+RUNALL_INCLUDE ..\prefix.lst
+RUNALL_CROSSLIST
+PM_CL="-fsanitize=address /Zi /wd4611 /w14640 /Zc:threadSafeInit-" PM_LINK="/debug"
+RUNALL_CROSSLIST
+PM_CL="/BE /c /EHsc /MD /std:c++14 /fno-sanitize-address-vcasan-lib"
+PM_CL="/BE /c /EHsc /MDd /std:c++17 /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/BE /c /EHsc /MT /std:c++20 /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/BE /c /EHsc /MTd /std:c++latest /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MD /std:c++14 /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MD /std:c++17 /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MD /std:c++20 /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MD /std:c++latest /permissive- /Zc:char8_t- /Zc:preprocessor /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MD /std:c++latest /permissive- /Zc:noexceptTypes- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MDd /std:c++14 /fp:except /Zc:preprocessor /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MDd /std:c++17 /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MDd /std:c++20 /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MDd /std:c++latest /permissive- /Zc:wchar_t- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MDd /std:c++latest /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MT /std:c++latest /permissive- /analyze:only /analyze:autolog- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MT /std:c++latest /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MTd /std:c++latest /permissive /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MTd /std:c++latest /permissive- /analyze:only /analyze:autolog- /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MTd /std:c++latest /permissive- /fp:strict /fno-sanitize-address-vcasan-lib"
+PM_CL="/EHsc /MTd /std:c++latest /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/Za /EHsc /MD /std:c++latest /permissive- /fno-sanitize-address-vcasan-lib"
+PM_CL="/Za /EHsc /MDd /std:c++latest /permissive- /fno-sanitize-address-vcasan-lib"
+PM_COMPILER="clang-cl" PM_CL="-fno-ms-compatibility -fno-delayed-template-parsing /EHsc /MD /std:c++14"
+PM_COMPILER="clang-cl" PM_CL="-fno-ms-compatibility -fno-delayed-template-parsing /EHsc /MD /std:c++17"
+PM_COMPILER="clang-cl" PM_CL="-fno-ms-compatibility -fno-delayed-template-parsing /EHsc /MT /std:c++latest /permissive-"
+PM_COMPILER="clang-cl" PM_CL="-fno-ms-compatibility -fno-delayed-template-parsing /EHsc /MT /std:c++latest /permissive- /D_HAS_CXX23 /fp:strict"