ENH: Add command line option for debug builds (#2572)

* add argument for debug builds

* clarify about behavior on windows

Author: david-cortes-intel

INSTALL.md

@@ -214,10 +214,21 @@ python setup.py build --abs-rpath
 
 **Note:** when building `scikit-learn-intelex` from source with this option, it will use the oneDAL library with which it was compiled. oneDAL has dependencies on other libraries such as TBB, which is also distributed as a python package through `pip` and as a `conda` package. By default, a conda environment will first try to load TBB from its own packages if it is installed in the environment, which might cause issues if oneDAL was compiled with a system TBB instead of a conda one. In such cases, it is advised to either uninstall TBB from pip/conda (it will be loaded from the oneDAL library which links to it), or modify the order of search paths in environment variables like `${LD_LIBRARY_PATH}`.
 
+### Debug Builds
+
+To build modules with debugging symbols and assertions enabled, pass argument `--debug` to the setup command - e.g.:
+
+```shell
+python setup.py build_ext --inplace --force --abs-rpath --debug
+python setup.py build --abs-rpath --debug
+```
+
+_**Note:** on Windows, this will only add debugging symbols for the `onedal` extension modules, but not for the `daal4py` extension module._
+
 ### Building with ASAN
 
 In order to use AddressSanitizer (ASan) together with `scikit-learn-intelex`, it's necessary to:
-* Build both oneDAL and scikit-learn-intelex with ASan (otherwise error traces will not be very informative).
+* Build both oneDAL and scikit-learn-intelex with ASan and with debug symbols (otherwise error traces will not be very informative).
 * Preload the ASan runtime when executing the Python process that imports `scikit-learn-intelex`.
 * Optionally, configure Python to use `malloc` as default allocator to reduce the number of false-positive leak reports.
 

scripts/build_backend.py

@@ -49,6 +49,7 @@ def custom_build_cmake_clib(
     use_abs_rpath=False,
     use_gcov=False,
     n_threads=1,
+    debug_build=False,
 ):
     import pybind11
 
@@ -128,6 +129,9 @@ def custom_build_cmake_clib(
         "-DoneDAL_USE_PARAMETERS_LIB=" + use_parameters_arg,
     ]
 
+    if debug_build:
+        cmake_args += ["-DCMAKE_BUILD_TYPE=Debug"]
+
     if build_distribute:
         cmake_args += [
             "-DMPI_INCLUDE_DIRS=" + MPI_INCDIRS,

setup.py

@@ -45,6 +45,11 @@
 if ARG_ABS_RPATH in sys.argv:
     USE_ABS_RPATH = True
     sys.argv = [arg for arg in sys.argv if arg != ARG_ABS_RPATH]
+DEBUG_BUILD = False
+ARG_DEBUG_BUILD = "--debug"
+if ARG_DEBUG_BUILD in sys.argv:
+    DEBUG_BUILD = True
+    sys.argv = [arg for arg in sys.argv if arg != ARG_DEBUG_BUILD]
 
 IS_WIN = False
 IS_MAC = False
@@ -302,6 +307,9 @@ def get_build_options():
     eca += get_sdl_cflags()
     ela += get_sdl_ldflags()
 
+    if DEBUG_BUILD and not IS_WIN:
+        eca += ["-g"]
+
     if IS_MAC:
         eca.append("-stdlib=libc++")
         ela.append("-stdlib=libc++")
@@ -320,6 +328,7 @@ def get_build_options():
                 for x in ["CPPFLAGS", "CFLAGS", "CXXFLAGS", "CC", "CXX", "LDFLAGS"]
             )
             and not USE_ABS_RPATH
+            and not DEBUG_BUILD
         ):
             ela.append("-s")
     return eca, ela, include_dir_plat
@@ -461,6 +470,7 @@ def onedal_run(self):
             use_abs_rpath=USE_ABS_RPATH,
             use_gcov=use_gcov,
             n_threads=n_threads,
+            debug_build=DEBUG_BUILD,
         )
         if is_onedal_iface:
             build_onedal("host")