Zengtudor/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2024-11-13 09:03:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
c557f9a3ad
pybind11/tests/test_descr_src_loc.cpp
Ralf W. Grosse-Kunstleve c557f9a3ad
[smart_holder] type_caster ODR guard (#4022) 
* Insert type_caster_odr_guard<> (an empty struct to start with).

* Add odr_guard_registry() used in type_caster_odr_guard() default constructor.

* Add minimal_real_caster (from PR #3862) to test_async, test_buffers

* VERY MESSY SNAPSHOT of WIP, this was the starting point for cl/454658864, which has more changes on top.

* Restore original test_async, test_buffers from current smart_holder HEAD

* Copy from cl/454991845 snapshot Jun 14, 5:08 PM

* Cleanup of tests. Systematically insert `if (make_caster<T>::translation_unit_local) {`

* Small simplification of odr_guard_impl()

* WIP

* Add PYBIND11_SOURCE_FILE_LINE macro.

* Replace PYBIND11_TYPE_CASTER_UNIQUE_IDENTIFIER with PYBIND11_TYPE_CASTER_SOURCE_FILE_LINE, baked into PYBIND11_TYPE_CASTER macro.

* Add more PYBIND11_DETAIL_TYPE_CASTER_ACCESS_TRANSLATION_UNIT_LOCAL; resolves "unused" warning when compiling test_custom_type_casters.cpp

* load_type fixes & follow-on cleanup

* Strip ./ from source_file_line

* Add new tests to CMakeLists.txt, disable PYBIND11_WERROR

* Replace C++17 syntax. Compiles with Debian clang 13 C++11 mode, but fails to link. Trying GitHub Actions anyway to see if there are any platforms that support https://en.cppreference.com/w/cpp/language/tu_local before C++20. Note that Debian clang 13 C++17 works locally.

* Show C++ version along with ODR VIOLATION DETECTED message.

* Add source_file_line_basename()

* Introduce PYBIND11_TYPE_CASTER_ODR_GUARD_ON (but not set automatically).

* Minor cleanup.

* Set PYBIND11_TYPE_CASTER_ODR_GUARD_ON automatically.

* Resolve clang-tidy error.

* Compatibility with old compilers.

* Fix off-by-one in source_file_line_basename()

* Report PYBIND11_INTERNALS_ID & C++ Version from pytest_configure()

* Restore use of PYBIND11_WERROR

* Move cpp_version_in_use() from cast.h to pybind11_tests.cpp

* define PYBIND11_DETAIL_ODR_GUARD_IMPL_THROW_DISABLED true in test_odr_guard_1,2.cpp

* IWYU cleanup of detail/type_caster_odr_guard.h

* Replace `throw err;` to resolve clang-tidy error.

* Add new header filename to CMakeLists.txt, test_files.py

* Experiment: Try any C++17 compiler.

* Fix ifdef for pragma GCC diagnostic.

* type_caster_odr_guard_impl() cleanup

* Move type_caster_odr_guard to type_caster_odr_guard.h

* Rename test_odr_guard* to test_type_caster_odr_guard*

* Remove comments that are (now) more distracting than helpful.

* Mark tu_local_no_data_always_false operator bool as explicit (clang-tidy). See also: https://stackoverflow.com/questions/39995573/when-can-i-use-explicit-operator-bool-without-a-cast

* New PYBIND11_TYPE_CASTER_ODR_GUARD_STRICT option (current on by default).

* Add test_type_caster_odr_registry_values(), test_type_caster_odr_violation_detected_counter()

* Report UNEXPECTED: test_type_caster_odr_guard_2.cpp prevailed (but do not fail).

* Apply clang-tidy suggestion.

* Attempt to handle valgrind behavior.

* Another attempt to handle valgrind behavior.

* Yet another attempt to handle valgrind behavior.

* Trying a new direction: show compiler info & std for UNEXPECTED: type_caster_odr_violation_detected_count() == 0

* compiler_info MSVC fix. num_violations == 0 condition.

* assert pybind11_tests.compiler_info is not None

* Introduce `make_caster_intrinsic<T>`, to be able to undo the 2 changes from `load_type` to `load_type<T>`. This is to avoid breaking 2 `pybind11::detail::load_type()` calls found in the wild (Google global testing).

One of the breakages in the wild was: 0f0f600767/python/tensorstore/subscript_method.h (L61)

* Add test for stl.h / stl_bind.h mix.

Manually verified that the ODR guard detects the ODR violation:

```
C++ Info: Debian Clang 13.0.1 C++17 __pybind11_internals_v4_clang_libstdcpp_cxxabi1002_sh_def__
=========================================================== test session starts ============================================================
platform linux -- Python 3.9.12, pytest-6.2.3, py-1.10.0, pluggy-0.13.1 -- /usr/bin/python3
...
================================================================= FAILURES =================================================================
_____________________________________________ test_type_caster_odr_violation_detected_counter ______________________________________________

    def test_type_caster_odr_violation_detected_counter():
        ...
        else:
>           assert num_violations == 1
E           assert 2 == 1
E             +2
E             -1

num_violations = 2

test_type_caster_odr_guard_1.py:51: AssertionError
========================================================= short test summary info ==========================================================
FAILED test_type_caster_odr_guard_1.py::test_type_caster_odr_violation_detected_counter - assert 2 == 1
======================================================= 1 failed, 5 passed in 0.08s ========================================================
```

* Eliminate need for `PYBIND11_DETAIL_TYPE_CASTER_ACCESS_TRANSLATION_UNIT_LOCAL` macro.

Copying code first developed by @amauryfa. I tried this at an earlier stage, but by itself this was insufficient. In the meantime I added in the TU-local mechanisms: trying again.

Passes local testing:
```
DISABLED std::system_error: ODR VIOLATION DETECTED: pybind11::detail::type_caster<mrc_ns::type_mrc>: SourceLocation1="/usr/local/google/home/rwgk/forked/pybind11/tests/test_type_caster_odr_guard_1.cpp:18", SourceLocation2="/usr/local/google/home/rwgk/forked/pybind11/tests/test_type_caster_odr_guard_2.cpp:19"
C++ Info: Debian Clang 13.0.1 C++17 __pybind11_internals_v4_clang_libstdcpp_cxxabi1002_sh_def__
=========================================================== test session starts ============================================================
platform linux -- Python 3.9.12, pytest-6.2.3, py-1.10.0, pluggy-0.13.1 -- /usr/bin/python3
cachedir: .pytest_cache
rootdir: /usr/local/google/home/rwgk/forked/pybind11/tests, configfile: pytest.ini
collected 6 items

test_type_caster_odr_guard_1.py::test_type_mrc_to_python PASSED
test_type_caster_odr_guard_1.py::test_type_mrc_from_python PASSED
test_type_caster_odr_guard_1.py::test_type_caster_odr_registry_values PASSED
test_type_caster_odr_guard_1.py::test_type_caster_odr_violation_detected_counter PASSED
test_type_caster_odr_guard_2.py::test_type_mrc_to_python PASSED
test_type_caster_odr_guard_2.py::test_type_mrc_from_python PASSED

============================================================ 6 passed in 0.01s =============================================================
```

* tu_local_descr with src_loc experiment

* clang-tidy suggested fixes

* Use source_file_line_from_sloc in type_caster_odr_guard_registry

* Disable type_caster ODR guard for __INTEL_COMPILER (see comment). Also turn off printf.

* Add missing include (discovered via google-internal testing).

* Work `scr_loc` into `descr`

* Use `TypeCasterType::name.sloc` instead of `source_file_line.sloc`

Manual re-verification:

```
+++ b/tests/test_type_caster_odr_guard_2.cpp
-    // m.def("pass_vector_type_mrc", mrc_ns::pass_vector_type_mrc);
+    m.def("pass_vector_type_mrc", mrc_ns::pass_vector_type_mrc);
```

```
>           assert num_violations == 1
E           assert 2 == 1

num_violations = 2

test_type_caster_odr_guard_1.py:51: AssertionError
```

* Fix small oversight (src_loc::here() -> src_loc{nullptr, 0}).

* Remove PYBIND11_DETAIL_TYPE_CASTER_ACCESS_TRANSLATION_UNIT_LOCAL macro completely.

* Remove PYBIND11_TYPE_CASTER_SOURCE_FILE_LINE macro completely. Some small extra cleanup.

* Minor tweaks looking at the PR with a fresh eye.

* src_loc comments

* Add new test_descr_src_loc & and fix descr.h `concat()` `src_loc` bug discovered while working on the test.

* Some more work on source code comments.

* Fully document the ODR violations in the ODR guard itself and introduce `PYBIND11_TYPE_CASTER_ODR_GUARD_ON_IF_AVAILABLE`

* Update comment (incl. mention of deadsnakes known to not work as intended).

* Use no-destructor idiom for type_caster_odr_guard_registry, as suggested by @laramiel

* Fix clang-tidy error: 'auto reg' can be declared as 'auto *reg' [readability-qualified-auto,-warnings-as-errors]

* WIP

* Revert "WIP" (tu_local_no_data_always_false_base experiment).

This reverts commit 31e8ac562f.

* Change `PYBIND11_TYPE_CASTER_ODR_GUARD_ON` to `PYBIND11_ENABLE_TYPE_CASTER_ODR_GUARD`, based on a suggestion by @rainwoodman

* Improved `#if` determining `PYBIND11_ENABLE_TYPE_CASTER_ODR_GUARD`, based on suggestion by @laramiel

* Make `descr::sloc` `const`, as suggested by @rainwoodman

* Rename macro to `PYBIND11_DETAIL_TYPE_CASTER_ODR_GUARD_IMPL_DEBUG`, as suggested by @laramiel

* Tweak comments some more (add "white hat hacker" analogy).

* Bring back `PYBIND11_CPP17` in determining `PYBIND11_ENABLE_TYPE_CASTER_ODR_GUARD`, to hopefully resolve most if not all of the many CI failures (89 failing, 32 successful: https://github.com/pybind/pybind11/runs/7430295771).

* Try another workaround for `__has_builtin`-related breakages (https://github.com/pybind/pybind11/runs/7430720321).

* Remove `defined(__has_builtin)` and subconditions.

* Update "known to not work" expectation in test and comment.

* `pytest.skip` `num_violations == 0` only `#ifdef __NO_INLINE__` (irrespective of the compiler)

* Systematically change all new `#ifdef` to `#if defined` (review suggestion).

* Bring back MSVC comment that got lost while experimenting.
2022-07-21 06:38:21 -07:00

142 lines
4.9 KiB
C++
Raw Blame History

// Copyright (c) 2022 The Pybind Development Team.
// All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
#include "pybind11_tests.h"
// This test actually works with almost all C++17 compilers, but is currently
// only needed (and tested) for type_caster_odr_guard.h, for simplicity.
#ifndef PYBIND11_ENABLE_TYPE_CASTER_ODR_GUARD
TEST_SUBMODULE(descr_src_loc, m) { m.attr("block_descr_offset") = py::none(); }
#else
namespace pybind11_tests {
namespace descr_src_loc {
using py::detail::const_name;
using py::detail::src_loc;
struct block_descr {
static constexpr unsigned offset = __LINE__;
static constexpr auto c0 = py::detail::descr<0>(src_loc::here());
static constexpr auto c1 = py::detail::descr<3>("Abc");
static constexpr auto c2 = py::detail::descr<1>(src_loc::here(), 'D');
static constexpr auto c3 = py::detail::descr<2>(src_loc::here(), 'E', 'f');
};
struct block_const_name {
static constexpr unsigned offset = __LINE__;
static constexpr auto c0 = const_name("G");
static constexpr auto c1 = const_name("Hi");
static constexpr auto c2 = const_name<0>();
static constexpr auto c3 = const_name<1>();
static constexpr auto c4 = const_name<23>();
static constexpr auto c5 = const_name<std::string>();
static constexpr auto c6 = const_name<true>("J", "K");
static constexpr auto c7 = const_name<false>("L", "M");
};
# if defined(PYBIND11_DETAIL_UNDERSCORE_BACKWARD_COMPATIBILITY)
struct block_underscore {
static constexpr unsigned offset = __LINE__;
// Using a macro to avoid copying the block_const_name code garbles the src_loc.line numbers.
static constexpr auto c0 = const_name("G");
static constexpr auto c1 = const_name("Hi");
static constexpr auto c2 = const_name<0>();
static constexpr auto c3 = const_name<1>();
static constexpr auto c4 = const_name<23>();
static constexpr auto c5 = const_name<std::string>();
static constexpr auto c6 = const_name<true>("J", "K");
static constexpr auto c7 = const_name<false>("L", "M");
};
# endif
struct block_plus {
static constexpr unsigned offset = __LINE__;
static constexpr auto c0 = const_name("N") + // critical line break
const_name("O");
static constexpr auto c1 = const_name("P", src_loc(nullptr, 0)) + // critical line break
const_name("Q");
};
struct block_concat {
static constexpr unsigned offset = __LINE__;
static constexpr auto c0 = py::detail::concat(const_name("R"));
static constexpr auto c1 = py::detail::concat(const_name("S"), // critical line break
const_name("T"));
static constexpr auto c2
= py::detail::concat(const_name("U", src_loc(nullptr, 0)), // critical line break
const_name("V"));
};
struct block_type_descr {
static constexpr unsigned offset = __LINE__;
static constexpr auto c0 = py::detail::type_descr(const_name("W"));
};
struct block_int_to_str {
static constexpr unsigned offset = __LINE__;
static constexpr auto c0 = py::detail::int_to_str<0>::digits;
static constexpr auto c1 = py::detail::int_to_str<4>::digits;
static constexpr auto c2 = py::detail::int_to_str<56>::digits;
};
} // namespace descr_src_loc
} // namespace pybind11_tests
TEST_SUBMODULE(descr_src_loc, m) {
using namespace pybind11_tests::descr_src_loc;
# define ATTR_OFFS(B) m.attr(# B "_offset") = B::offset;
# define ATTR_BLKC(B, C) \
m.attr(#B "_" #C) = py::make_tuple(B::C.text, B::C.sloc.file, B::C.sloc.line);
ATTR_OFFS(block_descr)
ATTR_BLKC(block_descr, c0)
ATTR_BLKC(block_descr, c1)
ATTR_BLKC(block_descr, c2)
ATTR_BLKC(block_descr, c3)
ATTR_OFFS(block_const_name)
ATTR_BLKC(block_const_name, c0)
ATTR_BLKC(block_const_name, c1)
ATTR_BLKC(block_const_name, c2)
ATTR_BLKC(block_const_name, c3)
ATTR_BLKC(block_const_name, c4)
ATTR_BLKC(block_const_name, c5)
ATTR_BLKC(block_const_name, c6)
ATTR_BLKC(block_const_name, c7)
ATTR_OFFS(block_underscore)
ATTR_BLKC(block_underscore, c0)
ATTR_BLKC(block_underscore, c1)
ATTR_BLKC(block_underscore, c2)
ATTR_BLKC(block_underscore, c3)
ATTR_BLKC(block_underscore, c4)
ATTR_BLKC(block_underscore, c5)
ATTR_BLKC(block_underscore, c6)
ATTR_BLKC(block_underscore, c7)
ATTR_OFFS(block_plus)
ATTR_BLKC(block_plus, c0)
ATTR_BLKC(block_plus, c1)
ATTR_OFFS(block_concat)
ATTR_BLKC(block_concat, c0)
ATTR_BLKC(block_concat, c1)
ATTR_BLKC(block_concat, c2)
ATTR_OFFS(block_type_descr)
ATTR_BLKC(block_type_descr, c0)
ATTR_OFFS(block_int_to_str)
ATTR_BLKC(block_int_to_str, c0)
ATTR_BLKC(block_int_to_str, c1)
ATTR_BLKC(block_int_to_str, c2)
}
#endif // PYBIND11_ENABLE_TYPE_CASTER_ODR_GUARD
Reference in New Issue View Git Blame Copy Permalink