From f525139a80d173feaea5518e842aceeb6ceec5cf Mon Sep 17 00:00:00 2001
From: Wenzel Jakob <wenzel.jakob@epfl.ch>
Date: Thu, 1 Jun 2023 16:32:26 +0200
Subject: [PATCH] reduce binary bloat of musllinux wheels

---
 cmake/nanobind-config.cmake | 12 +++++++++++-
 docs/api_cmake.rst          | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/cmake/nanobind-config.cmake b/cmake/nanobind-config.cmake
index 905bc6a9..58ca69cb 100644
--- a/cmake/nanobind-config.cmake
+++ b/cmake/nanobind-config.cmake
@@ -249,9 +249,15 @@ function (nanobind_set_visibility name)
   set_target_properties(${name} PROPERTIES CXX_VISIBILITY_PRESET hidden)
 endfunction()
 
+function (nanobind_musl_static_libcpp name)
+  if ("$ENV{AUDITWHEEL_PLAT}" MATCHES "musllinux")
+    target_link_options(${name} PRIVATE -static-libstdc++ -static-libgcc)
+  endif()
+endfunction()
+
 function(nanobind_add_module name)
   cmake_parse_arguments(PARSE_ARGV 1 ARG
-    "STABLE_ABI;NB_STATIC;NB_SHARED;PROTECT_STACK;LTO;NOMINSIZE;NOSTRIP;NOTRIM" "" "")
+    "STABLE_ABI;NB_STATIC;NB_SHARED;PROTECT_STACK;LTO;NOMINSIZE;NOSTRIP;NOTRIM;MUSL_DYNAMIC_LIBCPP" "" "")
 
   add_library(${name} MODULE ${ARG_UNPARSED_ARGUMENTS})
 
@@ -308,5 +314,9 @@ function(nanobind_add_module name)
     nanobind_lto(${name})
   endif()
 
+  if (ARG_NB_STATIC AND NOT ARG_MUSL_DYNAMIC_LIBCPP)
+    nanobind_musl_static_libcpp(${name})
+  endif()
+
   nanobind_set_visibility(${name})
 endfunction()
diff --git a/docs/api_cmake.rst b/docs/api_cmake.rst
index 8fd436fd..4e57ec36 100644
--- a/docs/api_cmake.rst
+++ b/docs/api_cmake.rst
@@ -62,6 +62,14 @@ The high-level interface consists of just one CMake command:
       * - ``NOSTRIP``
         - Don't strip unneded symbols and debug information from the compiled
           extension when performing release builds.
+      * - ``MUSL_DYNAMIC_LIBCPP``
+        - When `cibuildwheel
+          <https://cibuildwheel.readthedocs.io/en/stable/>`__ is used to
+          produce `musllinux <https://peps.python.org/pep-0656/>`__ wheels,
+          don't statically link against ``libstdc++`` and ``libgcc`` (which is
+          an optimization that nanobind does by default in this specific case).
+          If this explanation sounds confusing, then you can ignore it. See the
+          detailed description below for more information on this step.
 
    :cmake:command:`nanobind_add_module` performs the following
    steps to produce bindings.
@@ -146,6 +154,20 @@ The high-level interface consists of just one CMake command:
      bottleneck. That said, the optional ``LTO`` argument can be specified to
      enable LTO in release builds.
 
+   - nanobind's CMake build system is often combined with `cibuildwheel
+     <https://cibuildwheel.readthedocs.io/en/stable/>`__ to automate the
+     generation of wheels for many different platforms. One such platform
+     called `musllinux <https://peps.python.org/pep-0656/>`__ exists to create
+     tiny self-contained binaries that are cheap to install in a container
+     environment (Docker, etc.). An issue of the combination with nanobind is
+     that ``musllinux`` doesn't include the ``libstdc++`` and ``libgcc``
+     libraries which nanobind depends on. ``cibuildwheel`` then has to ship
+     those along in each wheel, which actually increases their size rather
+     dramatically (by a factor of >5x for small projects). To avoid this,
+     nanobind prefers to link against these libraries *statically* when it
+     detects a ``cibuildwheel`` build targeting ``musllinux``. Pass the
+     ``MUSL_DYNAMIC_LIBCPP`` parameter to avoid this behavior.
+
 .. _lowlevel-cmake:
 
 Low-level interface
@@ -196,6 +218,9 @@ is equivalent to
     # .. set important linker flags
     nanobind_link_options(my_ext)
 
+    # Statically link against libstdc++/libgcc when targeting musllinux
+    nanobind_musl_static_libcpp(${name})
+
 The various commands are described below:
 
 .. cmake:command:: nanobind_build_library
@@ -312,3 +337,10 @@ The various commands are described below:
    .. code-block:: cmake
 
       nanobind_link_options(my_target)
+
+.. cmake:command:: nanobind_musl_static_libcpp
+
+   This function passes the linker flags ``-static-libstdc++`` and
+   ``-static-libgcc`` to ``gcc`` when the environment variable
+   ``AUDITWHEEL_PLAT`` contains the string ``musllinux``, which indicates a
+   cibuildwheel build targeting that platform.