Skip to content

Add address sanitizer annotations to UninitializedMemoryHacks.h when building with msvc 2022 #1935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pps83 wants to merge 3 commits into
base: main
Choose a base branch
from
+41 −13
Open

Add address sanitizer annotations to UninitializedMemoryHacks.h when building with msvc 2022 #1935

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4778317
Add address sanitizer annotations when building with msvc 2022
pps83 Feb 17, 2023
2823f4a
Align with changes from ms/STL
pps83 Mar 20, 2025
89da72b
Remove unnecessary code
pps83 Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 41 additions & 13 deletions folly/memory/UninitializedMemoryHacks.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#include <type_traits>
#include <vector>

// On MSVC an incorrect <version> header get's picked up
// On MSVC an incorrect <version> header gets picked up
#if !defined(_MSC_VER) && __has_include(<version>)
#include <version>
#endif
Expand Down Expand Up @@ -243,33 +243,40 @@ struct MakeUnsafeStringSetLargerSize {

#elif defined(_MSC_VER)

#if defined(_ANNOTATE_STRING) || !defined(_DISABLE_STRING_ANNOTATION)
#ifdef __SANITIZE_ADDRESS__
#define _INSERT_STRING_ANNOTATION
#elif defined(__clang__)
#if __has_feature(address_sanitizer)
#define _INSERT_STRING_ANNOTATION
#endif
#endif
#endif

template <typename Tag, typename T, typename A, A Ptr_Eos>
struct MakeUnsafeStringSetLargerSize {
friend void unsafeStringSetLargerSizeImpl(
std::basic_string<T>& s, std::size_t n) {
#if _MSC_VER >= 1938 && defined(_INSERT_STRING_ANNOTATION)
const std::size_t n0 = s.size();
#endif
(s.*Ptr_Eos)(n);
#if _MSC_VER >= 1938 && defined(_INSERT_STRING_ANNOTATION)
if (_Asan_string_should_annotate && s.capacity() > std::string().capacity())
__sanitizer_annotate_contiguous_container(&s[0], &s[0] + s.capacity() + 1,
&s[0] + n0 + 1, &s[0] + n + 1);
#endif
}
};

#if _MSC_VER < 1939
#define FOLLY_DECLARE_STRING_RESIZE_WITHOUT_INIT(TYPE) \
template void std::basic_string<TYPE>::_Eos(std::size_t); \
template struct folly::detail::MakeUnsafeStringSetLargerSize< \
FollyMemoryDetailTranslationUnitTag, \
TYPE, \
void (std::basic_string<TYPE>::*)(std::size_t), \
&std::basic_string<TYPE>::_Eos>; \
FOLLY_DECLARE_STRING_RESIZE_WITHOUT_INIT_IMPL(TYPE)
#else
#define FOLLY_DECLARE_STRING_RESIZE_WITHOUT_INIT(TYPE) \
template struct folly::detail::MakeUnsafeStringSetLargerSize< \
FollyMemoryDetailTranslationUnitTag, \
TYPE, \
void (std::basic_string<TYPE>::*)(std::size_t), \
&std::basic_string<TYPE>::_Eos>; \
FOLLY_DECLARE_STRING_RESIZE_WITHOUT_INIT_IMPL(TYPE)
#endif // _MSC_VER < 1939
#else
#warning \
"No implementation for resizeWithoutInitialization of std::basic_string"
#endif
Expand Down Expand Up @@ -384,6 +391,16 @@ void unsafeVectorSetLargerSize(std::vector<T>& v, std::size_t n) {

#elif defined(_MSC_VER)

#if defined(_ANNOTATE_VECTOR) || !defined(_DISABLE_VECTOR_ANNOTATION)
#ifdef __SANITIZE_ADDRESS__
#define _INSERT_VECTOR_ANNOTATION
#elif defined(__clang__)
#if __has_feature(address_sanitizer)
#define _INSERT_VECTOR_ANNOTATION
#endif
#endif
#endif

template <
typename Tag,
typename T,
Expand All @@ -396,7 +413,13 @@ template <
struct MakeUnsafeVectorSetLargerSize : std::vector<T> {
friend void unsafeVectorSetLargerSizeImpl(std::vector<T>& v, std::size_t n) {
// v._Mypair._Myval2._Mylast += (n - v.size());
((v.*Ptr_Mypair).*Ptr_Myval2).*Ptr_Mylast += (n - v.size());
const std::size_t n0 = v.size();
((v.*Ptr_Mypair).*Ptr_Myval2).*Ptr_Mylast += (n - n0);
#if _MSC_VER >= 1930 && defined(_INSERT_VECTOR_ANNOTATION)
if (_Asan_vector_should_annotate)
__sanitizer_annotate_contiguous_container(&v[0], &v[0] + v.capacity(),
&v[0] + n0, &v[0] + n);
#endif
}
};

Expand All @@ -420,6 +443,11 @@ struct MakeUnsafeVectorSetLargerSize : std::vector<T> {
} // namespace detail
} // namespace folly

#if defined(_MSC_VER)
#undef _INSERT_STRING_ANNOTATION
#undef _INSERT_VECTOR_ANNOTATION
#endif

#if defined(FOLLY_DECLARE_VECTOR_RESIZE_WITHOUT_INIT)
FOLLY_DECLARE_VECTOR_RESIZE_WITHOUT_INIT(char)
FOLLY_DECLARE_VECTOR_RESIZE_WITHOUT_INIT(unsigned char)
Expand Down