Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 42 additions & 1 deletion stl/inc/__msvc_sanitizer_annotate_container.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ _STL_DISABLE_CLANG_WARNINGS
// (this will be auto-defined on unsupported platforms)
// + _DISABLE_STRING_ANNOTATION: same, but for only `basic_string`
// + _DISABLE_VECTOR_ANNOTATION: same, but for only `vector`
// + _DISABLE_OPTIONAL_ANNOTATION: same, but for only `optional`
// - _ENABLE_STL_ANNOTATION_ON_UNSUPPORTED_PLATFORMS: Don't auto-disable ASan annotations
// - _ANNOTATE_STL: Even when ASan annotations are disabled, insert the code for annotating into the STL anyways;
// this is useful when building static libraries which may be linked against both ASan and non-ASan binaries.
// + _ANNOTATE_STRING: same, but only for `basic_string`
// + _ANNOTATE_VECTOR: same, but only for `vector`
// + _ANNOTATE_OPTIONAL: same, but only for `optional`

#if !defined(_DISABLE_STL_ANNOTATION) && !defined(_ENABLE_STL_ANNOTATION_ON_UNSUPPORTED_PLATFORMS)

Expand All @@ -46,6 +48,9 @@ _STL_DISABLE_CLANG_WARNINGS
#ifndef _DISABLE_VECTOR_ANNOTATION
#define _DISABLE_VECTOR_ANNOTATION
#endif // ^^^ !defined(_DISABLE_VECTOR_ANNOTATION) ^^^
#ifndef _DISABLE_OPTIONAL_ANNOTATION
#define _DISABLE_OPTIONAL_ANNOTATION
#endif // ^^^ !defined(_DISABLE_OPTIONAL_ANNOTATION) ^^^

#endif // ^^^ defined(_DISABLE_STL_ANNOTATION) ^^^

Expand All @@ -59,6 +64,10 @@ _STL_DISABLE_CLANG_WARNINGS
#define _ANNOTATE_VECTOR
#endif // ^^^ !defined(_ANNOTATE_VECTOR) ^^^

#ifndef _ANNOTATE_OPTIONAL
#define _ANNOTATE_OPTIONAL
#endif // ^^^ !defined(_ANNOTATE_OPTIONAL) ^^^

#endif // ^^^ defined(_ANNOTATE_STL) ^^^

#ifdef __SANITIZE_ADDRESS__
Expand All @@ -67,6 +76,8 @@ _STL_DISABLE_CLANG_WARNINGS
#define _INSERT_STRING_ANNOTATION
#define _ACTIVATE_VECTOR_ANNOTATION
#define _INSERT_VECTOR_ANNOTATION
#define _ACTIVATE_OPTIONAL_ANNOTATION
#define _INSERT_OPTIONAL_ANNOTATION

#elif defined(__clang__) // ^^^ defined(__SANITIZE_ADDRESS__) / defined(__clang__) vvv

Expand All @@ -75,6 +86,8 @@ _STL_DISABLE_CLANG_WARNINGS
#define _INSERT_STRING_ANNOTATION
#define _ACTIVATE_VECTOR_ANNOTATION
#define _INSERT_VECTOR_ANNOTATION
#define _ACTIVATE_OPTIONAL_ANNOTATION
#define _INSERT_OPTIONAL_ANNOTATION
#pragma comment(linker, "/INFERASANLIBS")
#endif // __has_feature(address_sanitizer)

Expand All @@ -89,13 +102,20 @@ _STL_DISABLE_CLANG_WARNINGS
#undef _ACTIVATE_VECTOR_ANNOTATION
#undef _INSERT_VECTOR_ANNOTATION
#endif // ^^^ defined(_DISABLE_VECTOR_ANNOTATION) ^^^
#ifdef _DISABLE_OPTIONAL_ANNOTATION
#undef _ACTIVATE_OPTIONAL_ANNOTATION
#undef _INSERT_OPTIONAL_ANNOTATION
#endif // ^^^ defined(_DISABLE_OPTIONAL_ANNOTATION) ^^^

#ifdef _ANNOTATE_STRING
#define _INSERT_STRING_ANNOTATION
#endif // ^^^ defined(_ANNOTATE_STRING) ^^^
#ifdef _ANNOTATE_VECTOR
#define _INSERT_VECTOR_ANNOTATION
#endif // ^^^ defined(_ANNOTATE_VECTOR) ^^^
#ifdef _ANNOTATE_OPTIONAL
#define _INSERT_OPTIONAL_ANNOTATION
#endif // ^^^ defined(_ANNOTATE_OPTIONAL) ^^^


#ifndef _INSERT_STRING_ANNOTATION
Expand All @@ -104,6 +124,9 @@ _STL_DISABLE_CLANG_WARNINGS
#ifndef _INSERT_VECTOR_ANNOTATION
#pragma detect_mismatch("annotate_vector", "0")
#endif // ^^^ !defined(_INSERT_VECTOR_ANNOTATION) ^^^
#ifndef _INSERT_OPTIONAL_ANNOTATION
#pragma detect_mismatch("annotate_optional", "0")
#endif // ^^^ !defined(_INSERT_OPTIONAL_ANNOTATION) ^^^

#ifdef _ACTIVATE_STRING_ANNOTATION
#pragma comment(lib, "stl_asan")
Expand All @@ -113,9 +136,14 @@ _STL_DISABLE_CLANG_WARNINGS
#pragma comment(lib, "stl_asan")
#pragma detect_mismatch("annotate_vector", "1")
#endif // ^^^ defined(_ACTIVATE_VECTOR_ANNOTATION) ^^^
#ifdef _ACTIVATE_OPTIONAL_ANNOTATION
#pragma comment(lib, "stl_asan")
#pragma detect_mismatch("annotate_optional", "1")
#endif // ^^^ defined(_ACTIVATE_OPTIONAL_ANNOTATION) ^^^

#undef _ACTIVATE_STRING_ANNOTATION
#undef _ACTIVATE_VECTOR_ANNOTATION
#undef _ACTIVATE_OPTIONAL_ANNOTATION

extern "C" {
#ifdef _INSERT_VECTOR_ANNOTATION
Expand All @@ -125,10 +153,17 @@ extern const bool _Asan_vector_should_annotate;
#ifdef _INSERT_STRING_ANNOTATION
extern const bool _Asan_string_should_annotate;
#endif

#ifdef _INSERT_OPTIONAL_ANNOTATION
extern const bool _Asan_optional_should_annotate;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This variable isn't used. Is it really necessary?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a check for this variable inside the if(!_STD _Is_constant_evaluated()) block.

#endif
} // extern "C"

#if defined(_INSERT_VECTOR_ANNOTATION) || defined(_INSERT_STRING_ANNOTATION)
#if defined(_INSERT_VECTOR_ANNOTATION) || defined(_INSERT_STRING_ANNOTATION) || defined(_INSERT_OPTIONAL_ANNOTATION)
extern "C" {
void __cdecl __asan_poison_memory_region(void const volatile* addr, size_t size);
void __cdecl __asan_unpoison_memory_region(void const volatile* addr, size_t size);

// This must match ASan's primary declaration, which isn't marked `noexcept`.
void __cdecl __sanitizer_annotate_contiguous_container(
const void* _First, const void* _End, const void* _Old_last, const void* _New_last);
Expand All @@ -143,6 +178,8 @@ void __cdecl __sanitizer_annotate_contiguous_container(
#pragma comment(linker, "/alternatename:_Asan_vector_should_annotate=_Asan_vector_should_annotate_default")
#pragma comment(linker, "/alternatename:#_Asan_string_should_annotate=#_Asan_string_should_annotate_default")
#pragma comment(linker, "/alternatename:_Asan_string_should_annotate=_Asan_string_should_annotate_default")
#pragma comment(linker, "/alternatename:#_Asan_optional_should_annotate=#_Asan_optional_should_annotate_default")
#pragma comment(linker, "/alternatename:_Asan_optional_should_annotate=_Asan_optional_should_annotate_default")
#elif defined(_M_HYBRID)
#pragma comment(linker, \
"/alternatename:#__sanitizer_annotate_contiguous_container=#__sanitizer_annotate_contiguous_container_default")
Expand All @@ -152,16 +189,20 @@ void __cdecl __sanitizer_annotate_contiguous_container(
#pragma comment(linker, "/alternatename:__Asan_vector_should_annotate=__Asan_vector_should_annotate_default")
#pragma comment(linker, "/alternatename:#_Asan_string_should_annotate=#_Asan_string_should_annotate_default")
#pragma comment(linker, "/alternatename:__Asan_string_should_annotate=__Asan_string_should_annotate_default")
#pragma comment(linker, "/alternatename:#_Asan_optional_should_annotate=#_Asan_optional_should_annotate_default")
#pragma comment(linker, "/alternatename:__Asan_optional_should_annotate=__Asan_optional_should_annotate_default")
#elif defined(_M_IX86)
#pragma comment(linker, \
"/alternatename:___sanitizer_annotate_contiguous_container=___sanitizer_annotate_contiguous_container_default")
#pragma comment(linker, "/alternatename:__Asan_vector_should_annotate=__Asan_vector_should_annotate_default")
#pragma comment(linker, "/alternatename:__Asan_string_should_annotate=__Asan_string_should_annotate_default")
#pragma comment(linker, "/alternatename:__Asan_optional_should_annotate=__Asan_optional_should_annotate_default")
#elif defined(_M_X64) || defined(_M_ARM64)
#pragma comment(linker, \
"/alternatename:__sanitizer_annotate_contiguous_container=__sanitizer_annotate_contiguous_container_default")
#pragma comment(linker, "/alternatename:_Asan_vector_should_annotate=_Asan_vector_should_annotate_default")
#pragma comment(linker, "/alternatename:_Asan_string_should_annotate=_Asan_string_should_annotate_default")
#pragma comment(linker, "/alternatename:_Asan_optional_should_annotate=_Asan_optional_should_annotate_default")
#else // ^^^ known architecture / unknown architecture vvv
#error Unknown architecture
#endif // ^^^ unknown architecture ^^^
Expand Down
42 changes: 40 additions & 2 deletions stl/inc/optional
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ _EMIT_STL_WARNING(STL4038, "The contents of <optional> are available only with C
#if _HAS_CXX20
#include <compare>
#endif // _HAS_CXX20
#include <__msvc_sanitizer_annotate_container.hpp>
#include <exception>
#include <initializer_list>
#include <type_traits>
Expand Down Expand Up @@ -74,7 +75,13 @@ struct _Optional_destruct_base { // either contains a value of _Ty or is empty (
};
bool _Has_value;

constexpr _Optional_destruct_base() noexcept : _Dummy{}, _Has_value{false} {} // initialize an empty optional
constexpr _Optional_destruct_base() noexcept : _Dummy{}, _Has_value{false} { // initialize an empty optional
#ifdef _INSERT_OPTIONAL_ANNOTATION
if (!_STD _Is_constant_evaluated() && _Asan_optional_should_annotate) {
__asan_poison_memory_region(_STD addressof(_Value), sizeof(_Ty));
}
#endif
}

template <class... _Types>
constexpr explicit _Optional_destruct_base(in_place_t, _Types&&... _Args)
Expand All @@ -93,6 +100,11 @@ struct _Optional_destruct_base { // either contains a value of _Ty or is empty (

_CONSTEXPR20 void reset() noexcept {
_Has_value = false;
#ifdef _INSERT_OPTIONAL_ANNOTATION
if (!_STD _Is_constant_evaluated() && _Asan_optional_should_annotate) {
__asan_poison_memory_region(_STD addressof(_Value), sizeof(_Ty));
}
#endif
}
};

Expand All @@ -108,6 +120,12 @@ struct _Optional_destruct_base<_Ty, false> { // either contains a value of _Ty o
if (_Has_value) {
_Value.~_Ty();

#ifdef _INSERT_OPTIONAL_ANNOTATION
if (!_STD _Is_constant_evaluated() && _Asan_optional_should_annotate) {
__asan_poison_memory_region(_STD addressof(_Value), sizeof(_Ty));
}
#endif

#if _MSVC_STL_DESTRUCTOR_TOMBSTONES
// For the non-trivially destructible case, we can set the optional to be empty.
// We don't attempt to scribble over the bytes of the object's storage because that could be expensive
Expand All @@ -117,7 +135,13 @@ struct _Optional_destruct_base<_Ty, false> { // either contains a value of _Ty o
}
}

constexpr _Optional_destruct_base() noexcept : _Dummy{}, _Has_value{false} {} // initialize an empty optional
constexpr _Optional_destruct_base() noexcept : _Dummy{}, _Has_value{false} { // initialize an empty optional
#ifdef _INSERT_OPTIONAL_ANNOTATION
if (!_STD _Is_constant_evaluated() && _Asan_optional_should_annotate) {
__asan_poison_memory_region(_STD addressof(_Value), sizeof(_Ty));
}
#endif
}

template <class... _Types>
constexpr explicit _Optional_destruct_base(in_place_t, _Types&&... _Args)
Expand All @@ -139,6 +163,13 @@ struct _Optional_destruct_base<_Ty, false> { // either contains a value of _Ty o
_CONSTEXPR20 void reset() noexcept {
if (_Has_value) {
_Value.~_Ty();

#ifdef _INSERT_OPTIONAL_ANNOTATION
if (!_STD _Is_constant_evaluated() && _Asan_optional_should_annotate) {
__asan_poison_memory_region(_STD addressof(_Value), sizeof(_Ty));
}
#endif

_Has_value = false;
}
}
Expand All @@ -153,6 +184,13 @@ struct _Optional_construct_base : _Optional_destruct_base<_Ty> {
_CONSTEXPR20 _Ty& _Construct(_Types&&... _Args) noexcept(is_nothrow_constructible_v<_Ty, _Types...>) {
// transition from the empty to the value-containing state
_STL_INTERNAL_CHECK(!this->_Has_value);

#ifdef _INSERT_OPTIONAL_ANNOTATION
if (!_STD _Is_constant_evaluated() && _Asan_optional_should_annotate) {
__asan_unpoison_memory_region(_STD addressof(this->_Value), sizeof(_Ty));
}
#endif

_STD _Construct_in_place(this->_Value, _STD forward<_Types>(_Args)...);
this->_Has_value = true;
return this->_Value;
Expand Down
5 changes: 3 additions & 2 deletions stl/src/asan.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

namespace std {
extern "C" {
extern const bool _Asan_string_should_annotate = true;
extern const bool _Asan_vector_should_annotate = true;
extern const bool _Asan_string_should_annotate = true;
extern const bool _Asan_vector_should_annotate = true;
extern const bool _Asan_optional_should_annotate = true;
} // extern "C"
} // namespace std
5 changes: 3 additions & 2 deletions stl/src/asan_noop.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

extern "C" {
extern const bool _Asan_string_should_annotate_default = false;
extern const bool _Asan_vector_should_annotate_default = false;
extern const bool _Asan_string_should_annotate_default = false;
extern const bool _Asan_vector_should_annotate_default = false;
extern const bool _Asan_optional_should_annotate_default = false;

void __cdecl __sanitizer_annotate_contiguous_container_default(
const void*, const void*, const void*, const void*) noexcept {}
Expand Down
1 change: 1 addition & 0 deletions tests/std/test.lst
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,7 @@ tests\GH_005546_containers_size_type_cast
tests\GH_005553_regex_character_translation
tests\GH_005768_pow_accuracy
tests\GH_005800_stable_sort_large_alignment
tests\GH_005974_optional_asan
tests\LWG2381_num_get_floating_point
tests\LWG2510_tag_classes
tests\LWG2597_complex_branch_cut
Expand Down
4 changes: 4 additions & 0 deletions tests/std/tests/GH_005974_optional_asan/env.lst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Copyright (c) Microsoft Corporation.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

RUNALL_INCLUDE ..\usual_17_matrix.lst
72 changes: 72 additions & 0 deletions tests/std/tests/GH_005974_optional_asan/test.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
// Copyright (c) Microsoft Corporation.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#include <cassert>
#include <optional>

#ifdef __SANITIZE_ADDRESS__
extern "C" int __cdecl __asan_address_is_poisoned(void const volatile* addr);
#define ASAN_VERIFY_POISONED(addr) assert(__asan_address_is_poisoned((addr)) != 0)
#define ASAN_VERIFY_UNPOISONED(addr) assert(__asan_address_is_poisoned((addr)) == 0)
#else
#define ASAN_VERIFY_POISONED(addr) ((void) (addr))
#define ASAN_VERIFY_UNPOISONED(addr) ((void) (addr))
#endif

struct Payload {
long long x;
long long y;
long long z;
long long w;
};

void test_poison_on_empty_access() {
[[maybe_unused]] std::optional<Payload> opt;
ASAN_VERIFY_POISONED(reinterpret_cast<Payload*>(&opt));
}

void test_emplace_unpoisoning() {
std::optional<Payload> opt;
opt.emplace();
ASAN_VERIFY_UNPOISONED(reinterpret_cast<Payload*>(&opt));
}

void test_assignment_unpoisoning() {
std::optional<Payload> opt = std::nullopt;
opt = Payload{};
ASAN_VERIFY_UNPOISONED(reinterpret_cast<Payload*>(&opt));
}

void test_repoison_after_reset() {
std::optional<Payload> opt = Payload{};
ASAN_VERIFY_UNPOISONED(reinterpret_cast<Payload*>(&opt));
opt.reset();
ASAN_VERIFY_POISONED(reinterpret_cast<Payload*>(&opt));
}

constexpr bool test_constexpr() {
#if _HAS_CXX20
bool res = true;
std::optional<Payload> opt = std::nullopt;
opt = Payload{};
opt.reset();
opt = Payload{86, 0, 0, 0};
res = opt->x == 86;
opt.emplace(42, 0, 0, 0);
res = res && (opt->x == 42);
return res;
#else
std::optional<Payload> opt{Payload{86, 0, 0, 0}};
return opt->x == 86;
#endif
}

int main() {
test_poison_on_empty_access();
test_emplace_unpoisoning();
test_assignment_unpoisoning();
test_repoison_after_reset();
Comment on lines +65 to +68
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can make these cases constexpr-friendly and test them in static_assert since C++20.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a separate function to test constexpr functionality in static_assert.

static_assert(test_constexpr(), "constexpr test failed");

return 0;
}
Loading