[libc++] Make the Debug mode a configuration-time only option
authorLouis Dionne <ldionne.2@gmail.com>
Fri, 1 Apr 2022 20:38:30 +0000 (16:38 -0400)
committerLouis Dionne <ldionne.2@gmail.com>
Tue, 7 Jun 2022 20:33:53 +0000 (16:33 -0400)
commitf3966eaf869b7bdd9113ab9d5b78469eb0f5f028
treebcf158f004cdc3420525a87579837d445536e3b0
parent89c4b29e8d35ec352019d828e546bea3850403df
[libc++] Make the Debug mode a configuration-time only option

The debug mode has been broken pretty much ever since it was shipped
because it was possible to enable the debug mode in user code without
actually enabling it in the dylib, leading to ODR violations that
caused various kinds of failures.

This commit makes the debug mode a knob that is configured when
building the library and which can't be changed afterwards. This is
less flexible for users, however it will actually work as intended
and it will allow us, in the future, to add various kinds of checks
that do not assume the same ABI as the normal library. Furthermore,
this will make the debug mode more robust, which means that vendors
might be more tempted to support it properly, which hasn't been the
case with the current debug mode.

This patch shouldn't break any user code, except folks who are building
against a library that doesn't have the debug mode enabled and who try
to enable the debug mode in their code. Such users will get a compile-time
error explaining that this configuration isn't supported anymore.

In the future, we should further increase the granularity of the debug
mode checks so that we can cherry-pick which checks to enable, like we
do for unspecified behavior randomization.

Differential Revision: https://reviews.llvm.org/D122941
122 files changed:
libcxx/CMakeLists.txt
libcxx/cmake/caches/Apple.cmake
libcxx/cmake/caches/Generic-debug-iterators.cmake [deleted file]
libcxx/cmake/caches/Generic-debug-mode.cmake [new file with mode: 0644]
libcxx/cmake/caches/Generic-no-debug.cmake [deleted file]
libcxx/docs/DesignDocs/DebugMode.rst
libcxx/docs/ReleaseNotes.rst
libcxx/docs/TestingLibcxx.rst
libcxx/docs/UsingLibcxx.rst
libcxx/include/__algorithm/comp_ref_type.h
libcxx/include/__algorithm/nth_element.h
libcxx/include/__algorithm/partial_sort.h
libcxx/include/__algorithm/shuffle.h
libcxx/include/__algorithm/sort.h
libcxx/include/__algorithm/unwrap_iter.h
libcxx/include/__assert
libcxx/include/__config
libcxx/include/__config_site.in
libcxx/include/__debug
libcxx/include/__format/buffer.h
libcxx/include/__hash_table
libcxx/include/__iterator/wrap_iter.h
libcxx/include/list
libcxx/include/locale
libcxx/include/span
libcxx/include/string
libcxx/include/unordered_map
libcxx/include/unordered_set
libcxx/include/vector
libcxx/lib/abi/CMakeLists.txt
libcxx/src/CMakeLists.txt
libcxx/test/CMakeLists.txt
libcxx/test/libcxx/algorithms/alg.modifying.operations/copy.pass.cpp
libcxx/test/libcxx/algorithms/alg.sorting/alg.heap.operations/make.heap/complexity.pass.cpp
libcxx/test/libcxx/algorithms/alg.sorting/alg.heap.operations/sort.heap/complexity.pass.cpp
libcxx/test/libcxx/algorithms/debug_less.inconsistent.pass.cpp
libcxx/test/libcxx/algorithms/debug_less.pass.cpp
libcxx/test/libcxx/algorithms/nth_element_stability.pass.cpp
libcxx/test/libcxx/algorithms/partial_sort_stability.pass.cpp
libcxx/test/libcxx/algorithms/sort_stability.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.cons/debug.copy.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.modifiers/debug.emplace.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.modifiers/debug.erase.iter.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.modifiers/debug.erase.iter_iter.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.modifiers/debug.insert.iter_iter_iter.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.modifiers/debug.insert.iter_rvalue.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.modifiers/debug.insert.iter_size_value.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.modifiers/debug.insert.iter_value.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.ops/debug.splice.pos_list.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.ops/debug.splice.pos_list_iter.pass.cpp
libcxx/test/libcxx/containers/sequences/list/list.ops/debug.splice.pos_list_iter_iter.pass.cpp
libcxx/test/libcxx/containers/sequences/vector/debug.iterator.add.pass.cpp
libcxx/test/libcxx/containers/sequences/vector/debug.iterator.compare.pass.cpp
libcxx/test/libcxx/containers/sequences/vector/debug.iterator.decrement.pass.cpp
libcxx/test/libcxx/containers/sequences/vector/debug.iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/sequences/vector/debug.iterator.increment.pass.cpp
libcxx/test/libcxx/containers/sequences/vector/debug.iterator.index.pass.cpp
libcxx/test/libcxx/containers/sequences/vector/debug.iterator.subtract.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/debug.insert.hint_const_lvalue.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/debug.insert.hint_rvalue.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/debug.iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/debug.iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/debug.local_iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/debug.local_iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/debug.swap.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/unord.map.modifiers/debug.erase.iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.map/unord.map.modifiers/debug.erase.iter_iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/debug.insert.hint_const_lvalue.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/debug.insert.hint_rvalue.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/debug.iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/debug.iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/debug.local_iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/debug.local_iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/debug.swap.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/unord.multimap.modifiers/debug.erase.iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multimap/unord.multimap.modifiers/debug.erase.iter_iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.erase.iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.erase.iter_iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.insert.hint_const_lvalue.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.local_iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.local_iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.multiset/debug.swap.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.erase.iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.erase.iter_iter.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.insert.hint_const_lvalue.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.local_iterator.dereference.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.local_iterator.increment.pass.cpp
libcxx/test/libcxx/containers/unord/unord.set/debug.swap.pass.cpp
libcxx/test/libcxx/debug/containers.multithread.pass.cpp
libcxx/test/libcxx/debug/containers/associative_containers.pass.cpp
libcxx/test/libcxx/debug/containers/sequence_container_iterators.pass.cpp
libcxx/test/libcxx/debug/containers/string.pass.cpp
libcxx/test/libcxx/debug/containers/unord_containers.pass.cpp
libcxx/test/libcxx/debug/debug.assertions-enabled.compile.pass.cpp [new file with mode: 0644]
libcxx/test/libcxx/debug/debug.catch-legacy-macro.verify.cpp [new file with mode: 0644]
libcxx/test/libcxx/debug/extern-templates.sh.cpp
libcxx/test/libcxx/ranges/range.adaptors/range.lazy.split/range.lazy.split.inner/assert.equal.pass.cpp
libcxx/test/libcxx/ranges/range.adaptors/range.lazy.split/range.lazy.split.outer/assert.equal.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.iterators/debug.iterator.add.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.iterators/debug.iterator.compare.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.iterators/debug.iterator.decrement.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.iterators/debug.iterator.dereference.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.iterators/debug.iterator.increment.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.iterators/debug.iterator.index.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.iterators/debug.iterator.subtract.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.modifiers/debug.erase.iter.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.modifiers/debug.erase.iter_iter.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.modifiers/debug.insert.iter_char.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.modifiers/debug.insert.iter_iter_iter.pass.cpp
libcxx/test/libcxx/strings/basic.string/string.modifiers/debug.insert.iter_size_char.pass.cpp
libcxx/test/std/algorithms/alg.sorting/alg.merge/inplace_merge_comp.pass.cpp
libcxx/test/std/input.output/filesystems/fs.op.funcs/fs.op.proximate/proximate.pass.cpp
libcxx/test/std/utilities/format/format.functions/locale-specific_form.pass.cpp
libcxx/test/support/container_debug_tests.h
libcxx/utils/ci/buildkite-pipeline.yml
libcxx/utils/ci/run-buildbot
libcxx/utils/libcxx/test/features.py
libcxx/utils/libcxx/test/params.py