|
| 1 | +=========================================== |
| 2 | +Libc++ 19.0.0 (In-Progress) Release Notes |
| 3 | +=========================================== |
| 4 | + |
| 5 | +.. contents:: |
| 6 | + :local: |
| 7 | + :depth: 2 |
| 8 | + |
| 9 | +Written by the `Libc++ Team <https://libcxx.llvm.org>`_ |
| 10 | + |
| 11 | +.. warning:: |
| 12 | + |
| 13 | + These are in-progress notes for the upcoming libc++ 18.0.0 release. |
| 14 | + Release notes for previous releases can be found on |
| 15 | + `the Download Page <https://releases.llvm.org/download.html>`_. |
| 16 | + |
| 17 | +Introduction |
| 18 | +============ |
| 19 | + |
| 20 | +This document contains the release notes for the libc++ C++ Standard Library, |
| 21 | +part of the LLVM Compiler Infrastructure, release 18.0.0. Here we describe the |
| 22 | +status of libc++ in some detail, including major improvements from the previous |
| 23 | +release and new feature work. For the general LLVM release notes, see `the LLVM |
| 24 | +documentation <https://llvm.org/docs/ReleaseNotes.html>`_. All LLVM releases may |
| 25 | +be downloaded from the `LLVM releases web site <https://llvm.org/releases/>`_. |
| 26 | + |
| 27 | +For more information about libc++, please see the `Libc++ Web Site |
| 28 | +<https://libcxx.llvm.org>`_ or the `LLVM Web Site <https://llvm.org>`_. |
| 29 | + |
| 30 | +Note that if you are reading this file from a Git checkout or the |
| 31 | +main Libc++ web page, this document applies to the *next* release, not |
| 32 | +the current one. To see the release notes for a specific release, please |
| 33 | +see the `releases page <https://llvm.org/releases/>`_. |
| 34 | + |
| 35 | +What's New in Libc++ 18.0.0? |
| 36 | +============================== |
| 37 | + |
| 38 | +Implemented Papers |
| 39 | +------------------ |
| 40 | + |
| 41 | + |
| 42 | +Improvements and New Features |
| 43 | +----------------------------- |
| 44 | + |
| 45 | +- The internal structure ``__compressed_pair`` has been replaced with ``[[no_unique_address]]``, resulting in reduced |
| 46 | + compile times and smaller debug information as well as better code gen if optimizations are disabled. |
| 47 | + |
| 48 | +Deprecations and Removals |
| 49 | +------------------------- |
| 50 | + |
| 51 | + |
| 52 | +Upcoming Deprecations and Removals |
| 53 | +---------------------------------- |
| 54 | + |
| 55 | +LLVM 19 |
| 56 | +~~~~~~~ |
| 57 | + |
| 58 | +- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable that was used to enable the safe mode will be deprecated and setting |
| 59 | + it will trigger an error; use the ``LIBCXX_HARDENING_MODE`` variable with the value ``extensive`` instead. Similarly, |
| 60 | + the ``_LIBCPP_ENABLE_ASSERTIONS`` macro will be deprecated (setting it to ``1`` still enables the extensive mode the |
| 61 | + LLVM 19 release while also issuing a deprecation warning). See :ref:`the hardening documentation |
| 62 | + <using-hardening-modes>` for more details. |
| 63 | + |
| 64 | +- The base template for ``std::char_traits`` has been marked as deprecated and will be removed in LLVM 19. If you |
| 65 | + are using ``std::char_traits`` with types other than ``char``, ``wchar_t``, ``char8_t``, ``char16_t``, ``char32_t`` |
| 66 | + or a custom character type for which you specialized ``std::char_traits``, your code will stop working when we |
| 67 | + remove the base template. The Standard does not mandate that a base template is provided, and such a base template |
| 68 | + is bound to be incorrect for some types, which could currently cause unexpected behavior while going undetected. |
| 69 | + Note that the ``_LIBCPP_CHAR_TRAITS_REMOVE_BASE_SPECIALIZATION`` macro can be defined in LLVM 18 to eagerly remove |
| 70 | + the specialization and prepare code bases for the unconditional removal in LLVM 19. |
| 71 | + |
| 72 | +- The ``_LIBCPP_ENABLE_NARROWING_CONVERSIONS_IN_VARIANT`` macro that changed the behavior for narrowing conversions |
| 73 | + in ``std::variant`` will be removed in LLVM 19. |
| 74 | + |
| 75 | +- The ``_LIBCPP_ENABLE_CXX20_REMOVED_ALLOCATOR_MEMBERS`` macro has been deprecated in LLVM 18 and will be removed |
| 76 | + entirely in LLVM 19. |
| 77 | + |
| 78 | +- The ``_LIBCPP_ENABLE_CXX17_REMOVED_FEATURES`` and |
| 79 | + ``_LIBCPP_ENABLE_CXX20_REMOVED_FEATURES`` macros have been deprecated |
| 80 | + in LLVM 18 and will be removed entirely in LLVM 19. |
| 81 | + |
| 82 | +LLVM 20 |
| 83 | +~~~~~~~ |
| 84 | + |
| 85 | +- The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable and the ``_LIBCPP_ENABLE_ASSERTIONS`` macro that were used to enable |
| 86 | + the safe mode will be removed. |
| 87 | + |
| 88 | + |
| 89 | +ABI Affecting Changes |
| 90 | +--------------------- |
| 91 | + |
| 92 | +- The internal structure ``__compressed_pair`` has been replaced with ``[[no_unique_address]]``. This change results in |
| 93 | + empty final types to be placed at the beginning of the object instead of where the beginning of the |
| 94 | + ``__compressed_pair`` subobject was. This is only observable by checking the address of the subobject. |
| 95 | + |
| 96 | +Build System Changes |
| 97 | +-------------------- |
0 commit comments