BUILD: Change default buildtype from debug to release (#869)

Author: michal-shalev

.ci/jenkins/lib/build-container-matrix.yaml

@@ -88,6 +88,7 @@ steps:
         --base-image-tag "${BASE_IMAGE_TAG}" \
         --tag "${LOCAL_TAG_BASE}${arch}" \
         --arch "${arch}" \
+        --build-type debug \
         --no-cache
 
   - name: Add Version Info
@@ -174,7 +175,7 @@ steps:
         echo "benchmark/nixlbench/contrib/build.sh --base-image ${BASE_IMAGE} --base-image-tag ${BASE_IMAGE_TAG} --tag local-test-tag --arch ${arch} --no-cache --nixl \$WORKSPACE --ucx \$WORKSPACE/ucx-src"
       else
         echo "export UCX_REF=${UCX_VERSION}"
-        echo "contrib/build-container.sh --base-image ${BASE_IMAGE} --base-image-tag ${BASE_IMAGE_TAG} --tag local-test-tag --arch ${arch} --no-cache"
+        echo "contrib/build-container.sh --base-image ${BASE_IMAGE} --base-image-tag ${BASE_IMAGE_TAG} --tag local-test-tag --arch ${arch} --build-type debug --no-cache"
       fi
 
 pipeline_stop:

.ci/jenkins/lib/build-matrix.yaml

@@ -89,4 +89,4 @@ steps:
       ln -sfT $(type -p podman) /usr/bin/docker
       # install git for building container image
       yum install -y git
-      contrib/build-container.sh --no-cache
+      contrib/build-container.sh --build-type debug --no-cache

.gitlab/build.sh

@@ -227,7 +227,7 @@ export CMAKE_PREFIX_PATH="${INSTALL_DIR}:${CMAKE_PREFIX_PATH}"
 export UCX_TLS=^cuda_ipc
 
 # shellcheck disable=SC2086
-meson setup nixl_build --prefix=${INSTALL_DIR} -Ducx_path=${UCX_INSTALL_DIR} -Dbuild_docs=true -Drust=false ${EXTRA_BUILD_ARGS} -Dlibfabric_path="${LIBFABRIC_INSTALL_DIR}"
+meson setup nixl_build --prefix=${INSTALL_DIR} -Ducx_path=${UCX_INSTALL_DIR} -Dbuild_docs=true -Drust=false ${EXTRA_BUILD_ARGS} -Dlibfabric_path="${LIBFABRIC_INSTALL_DIR}" --buildtype=debug
 ninja -j"$NPROC" -C nixl_build && ninja -j"$NPROC" -C nixl_build install
 mkdir -p dist && cp nixl_build/src/bindings/python/nixl-meta/nixl-*.whl dist/
 

README.md

@@ -115,16 +115,16 @@ $ ninja install
 
 ### Build Options
 
-#### Release build
+#### Release build (default)
 
 ```bash
-$ meson setup <name_of_build_dir> --buildtype=release
+$ meson setup <name_of_build_dir>
 ```
 
-#### Debug build (default)
+#### Debug build
 
 ```bash
-$ meson setup <name_of_build_dir>
+$ meson setup <name_of_build_dir> --buildtype=debug
 ```
 
 #### NIXL-specific build options
@@ -202,7 +202,7 @@ For Python examples, see [examples/python/](examples/python/).
 ### Rust Bindings
 #### Build
 - Use `-Drust=true` meson option to build rust bindings.
-- Use `-Ddebug=false` for a release build.
+- Use `--buildtype=debug` for a debug build (default is release).
 - Or build manually:
     ```bash
     $ cargo build --release

contrib/Dockerfile

@@ -32,6 +32,7 @@ ARG NPROC
 ARG WHL_DEFAULT_PYTHON_VERSIONS="3.12"
 ARG LIBFABRIC_VERSION="v1.21.0"
 ARG LIBFABRIC_INSTALL_PATH="/usr/local"
+ARG BUILD_TYPE="release"
 
 # Install build dependencies from Ubuntu repository
 RUN apt-get update -y && \
@@ -201,7 +202,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends pybind11-dev
 ENV NIXL_PREFIX=$NIXL_PREFIX
 RUN rm -rf build && \
     mkdir build && \
-    meson setup -Dlibfabric_path=$LIBFABRIC_INSTALL_PATH build/ --prefix=$NIXL_PREFIX && \
+    meson setup -Dlibfabric_path=$LIBFABRIC_INSTALL_PATH build/ --prefix=$NIXL_PREFIX --buildtype=$BUILD_TYPE && \
     cd build && \
     ninja && \
     ninja install

contrib/Dockerfile.manylinux

@@ -22,6 +22,7 @@ ARG DEFAULT_PYTHON_VERSION="3.12"
 ARG ARCH="x86_64"
 ARG UCX_REF="v1.20.x"
 ARG LIBFABRIC_VERSION="v1.21.0"
+ARG BUILD_TYPE="release"
 
 RUN yum groupinstall -y 'Development Tools' &&  \
     dnf install -y almalinux-release-synergy && \
@@ -248,7 +249,7 @@ WORKDIR /workspace/nixl
 
 RUN rm -rf build && \
     mkdir build && \
-    meson setup build/ --prefix=/usr/local/nixl --buildtype=release \
+    meson setup build/ --prefix=/usr/local/nixl --buildtype=$BUILD_TYPE \
     -Dcudapath_lib="/usr/local/cuda/lib64" \
     -Dcudapath_inc="/usr/local/cuda/include" && \
     cd build && \

contrib/build-container.sh

@@ -38,6 +38,11 @@ WHL_PYTHON_VERSIONS="3.12"
 UCX_REF=${UCX_REF:-v1.20.x}
 OS="ubuntu24"
 NPROC=${NPROC:-$(nproc)}
+if [ "$CI" = "true" ]; then
+    BUILD_TYPE="debug"
+else
+    BUILD_TYPE="release"
+fi
 
 get_options() {
     while :; do
@@ -81,6 +86,14 @@ get_options() {
         --no-cache)
             NO_CACHE=" --no-cache"
             ;;
+        --build-type)
+            if [ "$2" ]; then
+                BUILD_TYPE=$2
+                shift
+            else
+                missing_requirement $1
+            fi
+            ;;
         --tag)
             if [ "$2" ]; then
                 TAG="--tag $2"
@@ -156,6 +169,7 @@ show_build_options() {
     echo "Python Versions for wheel build: ${WHL_PYTHON_VERSIONS}"
     echo "Wheel Platform: ${WHL_PLATFORM}"
     echo "UCX Ref: ${UCX_REF}"
+    echo "Build Type: ${BUILD_TYPE}"
 }
 
 show_help() {
@@ -165,6 +179,7 @@ show_help() {
     echo "  [--wheel-base base platform for wheel builds]"
     echo "  [--no-cache disable docker build cache]"
     echo "  [--os [ubuntu24|ubuntu22] to select Ubuntu version]"
+    echo "  [--build-type [debug|release] to select build type (default: release)]"
     echo "  [--tag tag for image]"
     echo "  [--python-versions python versions to build for, comma separated]"
     echo "  [--ucx-upstream use ucx master branch]"
@@ -196,6 +211,7 @@ BUILD_ARGS+=" --build-arg ARCH=$ARCH"
 BUILD_ARGS+=" --build-arg UCX_REF=$UCX_REF"
 BUILD_ARGS+=" --build-arg NPROC=$NPROC"
 BUILD_ARGS+=" --build-arg OS=$OS"
+BUILD_ARGS+=" --build-arg BUILD_TYPE=$BUILD_TYPE"
 
 show_build_options
 

meson.build

@@ -14,7 +14,7 @@
 # limitations under the License.
 
 project('nixl', 'CPP', version: '0.7.1',
-    default_options: ['buildtype=debug',
+    default_options: ['buildtype=release',
                 'werror=true',
                 'cpp_std=c++17',
                 'prefix=/opt/nvidia/nvda_nixl'],

src/plugins/gpunetio/README.md

@@ -51,5 +51,5 @@ NIXL bench also has the option to specify the DOCA GPUNetIO backend. An example
 
 ## Caveats
 
-By default NIXL is built with `buildtype=debug` option. This is ok for correctness and debugging.
-To run for performace (e.g. with NIXL bench) t's hightly recommended to build NIXL with `buildtype=release`.
+To run for performance (e.g. with NIXL bench) it's highly recommended to build NIXL with `buildtype=release`.
+For debugging purposes, NIXL can be built with `buildtype=debug`.