bocpy/setup.py at main · microsoft/bocpy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
import os
import re
import sys
from pathlib import Path

from setuptools import Extension, setup

# Load the README and strip any sections marked as PyPI-skip. GitHub still
# renders the original; PyPI's long_description gets the filtered version so
# unsupported content (e.g. Mermaid code blocks) does not appear as raw text.
_readme = Path(__file__).parent.joinpath("README.md").read_text(encoding="utf-8")
_readme = re.sub(
    r"<!-- pypi-skip-start -->.*?<!-- pypi-skip-end -->\n?",
    "",
    _readme,
    flags=re.DOTALL,
)

# The `_internal_test` extension exposes private C primitives (atomics,
# work-stealing queue cursors, MPMC behaviour queue) used only by the
# pytest suite. It must NOT ship in distributed wheels. It is only built
# when BOCPY_BUILD_INTERNAL_TESTS is set to a truthy value (e.g. "1"),
# which the developer-facing test workflow / CI test job sets explicitly.
#
# As a hard backstop we also refuse to build it when setuptools is being
# invoked to produce a wheel or sdist (e.g. by `pypa/cibuildwheel` in
# `.github/workflows/build_wheels.yml`), regardless of the env var. This
# guarantees the extension cannot leak into a release artifact even if a
# future workflow accidentally inherits BOCPY_BUILD_INTERNAL_TESTS=1.
_building_distribution = any(
    cmd in sys.argv for cmd in ("bdist_wheel", "bdist_egg", "sdist")
)
_build_internal_tests = (
    os.environ.get("BOCPY_BUILD_INTERNAL_TESTS", "").lower()
    in ("1", "true", "yes", "on")
    and not _building_distribution
)

_headers = [
    "src/bocpy/include/bocpy/bocpy.h",
    "src/bocpy/include/bocpy/xidata.h",
    "src/bocpy/boc_compat.h",
    "src/bocpy/boc_cown.h",
    "src/bocpy/boc_noticeboard.h",
    "src/bocpy/boc_sched.h",
    "src/bocpy/boc_tags.h",
    "src/bocpy/boc_terminator.h",
]

# Both directories are on the include path:
#   - ``src/bocpy/include`` is the public root, so internal C files
#     refer to public headers as ``<bocpy/bocpy.h>`` and downstream
#     consumers resolved via ``bocpy.get_include()`` see exactly the
#     same surface.
#   - ``src/bocpy`` is the private root, scoped by the ``boc_`` prefix
#     to avoid colliding with system headers (``sched.h``, ``tags.h``,
#     etc.) when this directory ends up on a downstream ``-I`` path.
_include_dirs = ["src/bocpy/include", "src/bocpy"]

# Numeric kernels in _math.c are stamped as small noinline helpers so the
# autovectoriser sees a clean inner loop. GCC's distutils default is
# ``-O2``, which sets ``-fvect-cost-model=very-cheap`` and declines to
# vectorise these loops; ``-O3`` promotes the model to ``dynamic`` and
# enables loop unrolling on top. Apple clang on macOS already vectorises
# at ``-O2`` but accepts ``-O3`` for parity. MSVC has no ``-O3``; its
# ``/O2`` is the autovectorising default that cibuildwheel already uses,
# included here explicitly so the build invariant is documented in one
# place. Per-extension scope: only ``_math`` opts in. The scheduler /
# messaging code in ``_core`` has no compute-bound inner loops and we do
# not want to perturb concurrency-critical code with extra IPA passes.
#
# Stays at ``-O3``; never ``-Ofast``/``-ffast-math``, which would break
# IEEE semantics that ``fabs``, ``nearbyint``, and NaN handling depend on.
if sys.platform == "win32":
    _math_extra_compile_args = ["/O2"]
else:
    _math_extra_compile_args = ["-O3"]

_ext_modules = [
    Extension(
        name="bocpy._core",
        sources=["src/bocpy/_core.c", "src/bocpy/boc_compat.c", "src/bocpy/boc_noticeboard.c",
                 "src/bocpy/boc_sched.c", "src/bocpy/boc_tags.c", "src/bocpy/boc_terminator.c"],
        depends=_headers,
        include_dirs=_include_dirs,
    ),
    Extension(
        name="bocpy._math",
        sources=["src/bocpy/_math.c", "src/bocpy/boc_compat.c"],
        depends=_headers,
        include_dirs=_include_dirs,
        extra_compile_args=_math_extra_compile_args,
    ),
]

if _build_internal_tests:
    _ext_modules.append(
        Extension(
            name="bocpy._internal_test",
            sources=[
                "src/bocpy/_internal_test.c",
                "src/bocpy/_internal_test_atomics.c",
                "src/bocpy/_internal_test_bq.c",
                "src/bocpy/_internal_test_wsq.c",
                "src/bocpy/_core.c",
                "src/bocpy/boc_compat.c",
                "src/bocpy/boc_noticeboard.c",
                "src/bocpy/boc_sched.c",
                "src/bocpy/boc_tags.c",
                "src/bocpy/boc_terminator.c",
            ],
            depends=_headers,
            include_dirs=_include_dirs,
        )
    )

setup(
    long_description=_readme,
    long_description_content_type="text/markdown",
    ext_modules=_ext_modules,
)