Skip to content

BUILD: Change default buildtype from debug to release #869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

BUILD: Change default buildtype from debug to release #869

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
629d131
BUILD: Change default buildtype from debug to release
michal-shalev Oct 6, 2025
0ca1dc5
Merge branch 'main' into change-default-buildtype-to-release
michal-shalev Oct 15, 2025
abf8cd7
PR fixes
michal-shalev Oct 15, 2025
6ef2dea
Merge branch 'main' into change-default-buildtype-to-release
michal-shalev Oct 15, 2025
f1a9592
PR fixes 2.0
michal-shalev Oct 15, 2025
9704852
Merge branch 'main' into change-default-buildtype-to-release
ovidiusm Nov 4, 2025
f438b37
Fix typo
michal-shalev Nov 4, 2025
3c86c83
Make AWS S3 Tests buildtype debug
michal-shalev Nov 4, 2025
8d853a4
Make AWS Test buildtype debug
michal-shalev Nov 4, 2025
9f3e26a
Make AWS S3 Tests buildtype debug
michal-shalev Nov 4, 2025
008ae6c
Fix build.sh to run with --buildtype=debug
michal-shalev Nov 4, 2025
f787af0
Merge branch 'main' into change-default-buildtype-to-release
michal-shalev Nov 4, 2025
8d73df8
Make Docker build type configurable via BUILD_TYPE arg
michal-shalev Nov 4, 2025
a1c3126
Fix Docker build to pass BUILD_TYPE parameter
michal-shalev Nov 4, 2025
14ac5d5
Merge branch 'main' into change-default-buildtype-to-release
michal-shalev Nov 4, 2025
f7f99e6
Fix Dockerfile.manylinux as well
michal-shalev Nov 4, 2025
b433b33
Merge branch 'main' into change-default-buildtype-to-release
michal-shalev Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitlab/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/

Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,16 +102,16 @@ $ ninja install

### Build Options

#### Release build
#### Release build (default)

```bash
$ meson setup <name_of_build_dir> --buildtype=release
Copy link
Contributor

@aranadive aranadive Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove buildtype arg here

```

#### Debug build (default)
#### Debug build

```bash
$ meson setup <name_of_build_dir>
$ meson setup <name_of_build_dir> --buildtype=debug
```

#### NIXL-specific build options
Expand Down Expand Up @@ -170,7 +170,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
Expand Down
2 changes: 1 addition & 1 deletion meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'],
Expand Down
4 changes: 2 additions & 2 deletions src/plugins/gpunetio/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.