Enable Debug build for native code in spark-rapids-jni #1573
Conversation
…o enable building native code with debug symbols Signed-off-by: Navin Kumar <[email protected]>
| @@ -81,6 +81,9 @@ | |||
| <RMM_LOGGING_LEVEL>OFF</RMM_LOGGING_LEVEL> | |||
| <SPARK_RAPIDS_JNI_CXX_FLAGS/> | |||
| <USE_GDS>OFF</USE_GDS> | |||
| <LIBCUDF_BUILD_TYPE>Release</LIBCUDF_BUILD_TYPE> | |||
| <BUILD_TYPE>${LIBCUDF_BUILD_TYPE}</BUILD_TYPE> | |||
| <CUDA_FLAGS_DEBUG>-g</CUDA_FLAGS_DEBUG> | |||
There was a problem hiding this comment.
Is this intended to be overridden by the user for some use cases? I assume this is only used for Debug builds, and I'm a bit surprised this needs to be specified at all.
There was a problem hiding this comment.
Yeah, it's a little weird, but the default flags only adds -g (which enables debugging in host code), you need -G to enable debugging in device code as well.
| @@ -81,6 +81,9 @@ | |||
| <RMM_LOGGING_LEVEL>OFF</RMM_LOGGING_LEVEL> | |||
| <SPARK_RAPIDS_JNI_CXX_FLAGS/> | |||
| <USE_GDS>OFF</USE_GDS> | |||
| <LIBCUDF_BUILD_TYPE>Release</LIBCUDF_BUILD_TYPE> | |||
There was a problem hiding this comment.
In my previous experience, libcudf as a whole fails to build with BUILD_TYPE=Debug. I have been relying on selective Debug compiling https://github.com/rapidsai/cudf/blob/branch-23.12/CONTRIBUTING.md#device-debug-symbols. After a certain threshold depending on how many files are compiled with debugging symbols, the plugin slow to start or hangs for me.
There was a problem hiding this comment.
I'm wondering now, if I should try the CUDF approach here with spark-rapids-jni code and then maybe file another PR with a similar section in spark-rapids-jni CONTRIBUTING.md if that works with the way we build.
Might make a bit more sense then.
There was a problem hiding this comment.
Closing this for now.
This adds the ability to build the native code with debug symbols that can be used in gdb and cuda-gdb. We separate out the build types for libcudf and libsparkrapidsjni because building libcudf with debug symbols is incredibly slow and should only be used by an advanced developer.
In order to build the debug version of libsparkrapidsjni, you can use:
Note, the
CUDA_FLAGS_DEBUGsetting here. By default this value is only-gwhich only enables debug symbols in host code. You need to add-Gto enable debug symbols for device code. You need to set theBUILD_TYPEtoDebugto enable the usage of these flags (by default, this isRelease).Debug builds can be quite slow so this should only be used if you really need to debug native code on device.