Skip to content

Commit a85bac8

Browse files
rwgkrwgk
committed
Add test_namespace_visibility
To probe environment/toolchain/platform-specific behavior under the exact same conditions as normal tests. (An earlier version of this code was used to inform PR pybind#4043.)
1 parent f158f96 commit a85bac8

File tree

6 files changed

+139
-2
lines changed

6 files changed

+139
-2
lines changed

‎tests/CMakeLists.txt‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ set(PYBIND11_TEST_FILES
157157
test_methods_and_attributes
158158
test_modules
159159
test_multiple_inheritance
160+
test_namespace_visibility.py
160161
test_numpy_array
161162
test_numpy_dtypes
162163
test_numpy_vectorize
@@ -236,6 +237,7 @@ tests_extra_targets("test_exceptions.py" "cross_module_interleaved_error_already
236237
tests_extra_targets("test_gil_scoped.py" "cross_module_gil_utils")
237238
tests_extra_targets("test_class_sh_module_local.py"
238239
"class_sh_module_local_0;class_sh_module_local_1;class_sh_module_local_2")
240+
tests_extra_targets("test_namespace_visibility.py" "namespace_visibility_1;namespace_visibility_2")
239241

240242
set(PYBIND11_EIGEN_REPO
241243
"https://gitlab.com/libeigen/eigen.git"
@@ -426,8 +428,11 @@ if(PYBIND11_CUDA_TESTS)
426428
endif()
427429

428430
foreach(target ${test_targets})
429-
set(test_files ${PYBIND11_TEST_FILES})
430-
if(NOT "${target}" STREQUAL "pybind11_tests")
431+
if("${target}" STREQUAL "pybind11_tests")
432+
set(test_files ${PYBIND11_TEST_FILES})
433+
elseif("${target}" STREQUAL "namespace_visibility_1")
434+
set(test_files namespace_visibility_1s.cpp)
435+
else()
431436
set(test_files "")
432437
endif()
433438

‎tests/namespace_visibility.h‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Copyright (c) 2022 The Pybind Development Team.
2+
// All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
#pragma once
6+
7+
#include <cstddef>
8+
9+
#ifdef __GNUG__
10+
# define PYBIND11_NS_VIS_U /* unspecified */
11+
# define PYBIND11_NS_VIS_H __attribute__((visibility("hidden")))
12+
#else
13+
# define PYBIND11_NS_VIS_U
14+
# define PYBIND11_NS_VIS_H
15+
#endif
16+
17+
#define PYBIND11_NS_VIS_FUNC \
18+
inline std::ptrdiff_t func() { \
19+
static std::ptrdiff_t value = 0; \
20+
return reinterpret_cast<std::ptrdiff_t>(&value); \
21+
}
22+
23+
#define PYBIND11_NS_VIS_DEFS \
24+
m.def("ns_vis_uuu_func", pybind11_ns_vis_uuu::func); \
25+
m.def("ns_vis_uuh_func", pybind11_ns_vis_uuh::func); \
26+
m.def("ns_vis_uhu_func", pybind11_ns_vis_uhu::func); \
27+
m.def("ns_vis_uhh_func", pybind11_ns_vis_uhh::func); \
28+
m.def("ns_vis_huu_func", pybind11_ns_vis_huu::func); \
29+
m.def("ns_vis_huh_func", pybind11_ns_vis_huh::func); \
30+
m.def("ns_vis_hhu_func", pybind11_ns_vis_hhu::func); \
31+
m.def("ns_vis_hhh_func", pybind11_ns_vis_hhh::func);

‎tests/namespace_visibility_1.cpp‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#include "pybind11/pybind11.h"
2+
#include "namespace_visibility.h"
3+
4+
// clang-format off
5+
namespace pybind11_ns_vis_uuu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
6+
namespace pybind11_ns_vis_uuh PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
7+
namespace pybind11_ns_vis_uhu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
8+
namespace pybind11_ns_vis_uhh PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
9+
namespace pybind11_ns_vis_huu PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
10+
namespace pybind11_ns_vis_huh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
11+
namespace pybind11_ns_vis_hhu PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
12+
namespace pybind11_ns_vis_hhh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
13+
// ^ ^
14+
// bit used .............. here
15+
// clang-format on
16+
17+
void namespace_visibility_1s(pybind11::module_ &m);
18+
19+
PYBIND11_MODULE(namespace_visibility_1, m) {
20+
PYBIND11_NS_VIS_DEFS
21+
22+
auto sm = m.def_submodule("submodule");
23+
namespace_visibility_1s(sm);
24+
}

‎tests/namespace_visibility_1s.cpp‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#include "pybind11/pybind11.h"
2+
#include "namespace_visibility.h"
3+
4+
// clang-format off
5+
namespace pybind11_ns_vis_uuu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
6+
namespace pybind11_ns_vis_uuh PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
7+
namespace pybind11_ns_vis_uhu PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
8+
namespace pybind11_ns_vis_uhh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
9+
namespace pybind11_ns_vis_huu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
10+
namespace pybind11_ns_vis_huh PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
11+
namespace pybind11_ns_vis_hhu PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
12+
namespace pybind11_ns_vis_hhh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
13+
// ^ ^
14+
// bit used ............. here
15+
// clang-format on
16+
17+
void namespace_visibility_1s(pybind11::module_ &m) { PYBIND11_NS_VIS_DEFS }

‎tests/namespace_visibility_2.cpp‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#include "pybind11/pybind11.h"
2+
#include "namespace_visibility.h"
3+
4+
// clang-format off
5+
namespace pybind11_ns_vis_uuu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
6+
namespace pybind11_ns_vis_uuh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
7+
namespace pybind11_ns_vis_uhu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
8+
namespace pybind11_ns_vis_uhh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
9+
namespace pybind11_ns_vis_huu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
10+
namespace pybind11_ns_vis_huh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
11+
namespace pybind11_ns_vis_hhu PYBIND11_NS_VIS_U { PYBIND11_NS_VIS_FUNC }
12+
namespace pybind11_ns_vis_hhh PYBIND11_NS_VIS_H { PYBIND11_NS_VIS_FUNC }
13+
// ^ ^
14+
// bit used ............ here
15+
// clang-format on
16+
17+
PYBIND11_MODULE(namespace_visibility_2, m) { PYBIND11_NS_VIS_DEFS }

‎tests/test_namespace_visibility.py‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# This is not really a unit test, but probing environment/toolchain/platform-specific
2+
# behavior under the exact same conditions as normal tests.
3+
# The results are useful to understanding the effects of, e.g., removing
4+
# `-fvisibility=hidden` or `__attribute__((visibility("hidden")))`, or linking
5+
# extensions statically with the core Python interpreter.
6+
7+
import itertools
8+
9+
import namespace_visibility_1
10+
import namespace_visibility_2
11+
import pytest
12+
13+
14+
def test_namespace_visibility():
15+
modules = (
16+
namespace_visibility_1,
17+
namespace_visibility_1.submodule,
18+
namespace_visibility_2,
19+
)
20+
unique_pointer_labels = "ABC"
21+
unique_pointers_observed = []
22+
# u = visibility unspecified
23+
# h = visibility hidden
24+
for visibility in itertools.product(*([("u", "h")] * len(modules))):
25+
# See functions in namespace_visibility_*.cpp
26+
func = "ns_vis_" + "".join(visibility) + "_func"
27+
ptrs = []
28+
uq_ptrs_obs = ""
29+
for vis, m in zip(visibility, modules):
30+
ptr = getattr(m, func)()
31+
ptrs.append(ptr)
32+
lbl = unique_pointer_labels[ptrs.index(ptr)]
33+
if vis == "h":
34+
# Encode u/h info as upper/lower case to make the final result
35+
# as compact as possible.
36+
lbl = lbl.lower()
37+
uq_ptrs_obs += lbl
38+
unique_pointers_observed.append(uq_ptrs_obs)
39+
all_unique_pointers_observed = ":".join(unique_pointers_observed)
40+
if all_unique_pointers_observed != "AAC:AAc:AaC:Aac:aAC:aAc:aaC:aac":
41+
pytest.skip(
42+
f"UNUSUAL all_unique_pointers_observed: {all_unique_pointers_observed}"
43+
)

0 commit comments

Comments
 (0)