Skip to content

Commit

Permalink
[libc++][hardening][NFC] Fix the 17 release notes to remove mentions …
Browse files Browse the repository at this point in the history
…of hardening

This is to bring `main` in sync with `release/17.x` after https://reviews.llvm.org/D159171.

Differential Revision: https://reviews.llvm.org/D159454
  • Loading branch information
var-const committed Sep 8, 2023
1 parent c86d896 commit 5795e7b
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion libcxx/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -786,7 +786,7 @@ elseif (LIBCXX_HARDENING_MODE STREQUAL "unchecked")
config_define(0 _LIBCPP_ENABLE_HARDENED_MODE_DEFAULT)
config_define(0 _LIBCPP_ENABLE_DEBUG_MODE_DEFAULT)
endif()
# TODO(LLVM 18): Remove this after branching for LLVM 17, this is a simple
# TODO(LLVM 19): Remove this after branching for LLVM 18, this is a simple
# courtesy for vendors to be notified about this change.
if (LIBCXX_ENABLE_ASSERTIONS)
message(FATAL_ERROR "LIBCXX_ENABLE_ASSERTIONS has been replaced by LIBCXX_HARDENING_MODE=hardened")
Expand Down
13 changes: 2 additions & 11 deletions libcxx/docs/ReleaseNotes/17.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,6 @@ Improvements and New Features
``std::ranges::find`` are now forwarding to ``std::memcmp`` for trivially
equality comparable types, which can lead up to 40x performance improvements.

- ``std::string_view`` now provides iterators that check for out-of-bounds accesses when the safe
libc++ mode is enabled.

- The performance of ``dynamic_cast`` on its hot paths is greatly improved and is as efficient as the
``libsupc++`` implementation. Note that the performance improvements are shipped in ``libcxxabi``.

Expand Down Expand Up @@ -128,14 +125,8 @@ Improvements and New Features
Deprecations and Removals
-------------------------

- The "safe" mode is replaced by the hardened mode in this release. The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable is
deprecated and setting it will trigger an error; use ``LIBCXX_HARDENING_MODE`` instead. Similarly, the
``_LIBCPP_ENABLE_ASSERTIONS`` macro is deprecated and setting it to ``1`` now enables the hardened mode. See
``libcxx/docs/Hardening.rst`` for more details.

- The legacy debug mode has been removed in this release. Setting the macro ``_LIBCPP_ENABLE_DEBUG_MODE`` to ``1`` now
enables the new debug mode which is part of hardening (see the "Improvements and New Features" section above). The
``LIBCXX_ENABLE_DEBUG_MODE`` CMake variable has been removed. For additional context, refer to the `Discourse post
- The legacy debug mode has been removed in this release. The ``LIBCXX_ENABLE_DEBUG_MODE`` CMake variable has been
removed. For additional context, refer to the `Discourse post
<https://discourse.llvm.org/t/rfc-removing-the-legacy-debug-mode-from-libc/71026>`_.

- The ``<experimental/coroutine>`` header has been removed in this release. The ``<coroutine>`` header
Expand Down
9 changes: 9 additions & 0 deletions libcxx/docs/ReleaseNotes/18.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ see the `releases page <https://llvm.org/releases/>`_.
What's New in Libc++ 18.0.0?
==============================

- The "safe" mode is replaced by the hardened mode in this release. The
``LIBCXX_ENABLE_ASSERTIONS`` CMake variable is deprecated and setting it will
trigger an error; use ``LIBCXX_HARDENING_MODE`` instead. Similarly, the
``_LIBCPP_ENABLE_ASSERTIONS`` macro is deprecated and setting it to ``1`` now
enables the hardened mode. See ``libcxx/docs/Hardening.rst`` for more details.

- A new debug mode has been added, replacing the legacy debug mode that was
removed in the LLVM 17 release. See ``libcxx/docs/Hardening.rst`` for more
details.

Implemented Papers
------------------
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__config
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@

// HARDENING {

// TODO(hardening): remove this in LLVM 18.
// TODO(hardening): remove this in LLVM 19.
// This is for backward compatibility -- make enabling `_LIBCPP_ENABLE_ASSERTIONS` (which predates hardening modes)
// equivalent to setting the hardened mode.
# ifdef _LIBCPP_ENABLE_ASSERTIONS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
//
//===----------------------------------------------------------------------===//

// TODO(hardening): remove in LLVM 18.
// TODO(hardening): remove in LLVM 19.
// This test ensures that enabling assertions now enables the hardened mode.

// `check_assertion.h` is only available starting from C++11 and requires Unix headers.
Expand Down

0 comments on commit 5795e7b

Please sign in to comment.