Skip to content

building.md

Latest commit

 

History

History
65 lines (42 loc) · 4.21 KB

building.md

File metadata and controls

65 lines (42 loc) · 4.21 KB
Raw

Building

Prerequisites

  • Compiler: GCC 15+ with C++26 support
  • Build system: CMake 4.2+
  • Package manager: Conan 2.x
  • OS: Linux

Build

conan install . -pr:h ./conan/profiles/gcc-26-debug -pr:b default \
  --lockfile=conan.lock --build=missing
conan build . -pr:h ./conan/profiles/gcc-26-debug -pr:b default \
  --lockfile=conan.lock --build=missing
ctest --test-dir build/Debug --output-on-failure

Release profile: replace gcc-26-debug with gcc-26. The binary is build/Debug/src/nesso or build/Release/src/nesso.

Compile options

nesso_options is an INTERFACE library in CMakeLists.txt. Every nesso target links it, including tests, the fuzz harnesses, and the benchmark. It requests C++26 (cxx_std_26), turns compiler extensions off, and adds the warning set below for GCC and Clang. Those options are usage requirements of the nesso targets. They are not applied when ONNX Runtime, Catch2, CLI11, or nlohmann-json is built. Profile optimization, sanitizer, and LTO flags stay in user.nesso:cxxflags for the same reason.

-Werror is off unless NESSO_WERROR is ON (-DNESSO_WERROR=ON for a plain CMake build). No profile sets it. conanfile.py turns it on when the command passes -c user.nesso:werror=True. conan build writes the toolchain again, so omit the flag there and the build comes back without -Werror. NESSO_WERROR=1 makes scripts/code-coverage pass that -c on conan build and scripts/fuzz-test pass it on conan install. The default is off.

conan/profiles/gcc-26-debug passes -fno-sanitize-recover=all with -fsanitize=address,undefined. ASan and UBSan stop on the first error without UBSAN_OPTIONS.

GCC and Clang:

-Wall -Wextra -Wpedantic -Wconversion -Wsign-conversion -Wshadow -Wformat=2 -Wold-style-cast -Wnon-virtual-dtor -Woverloaded-virtual -Wnull-dereference -Wdouble-promotion -Wimplicit-fallthrough -Wcast-align -Wextra-semi

GCC only:

-Wduplicated-cond -Wduplicated-branches -Wlogical-op -Wuseless-cast

Inside the nesso-build-env image (CONAN_HOME=/opt/conan2) keep --lockfile=conan.lock and --no-remote. Outside that image, drop --no-remote.

The black-box specs in test/functional/ run the nesso binary through godog as the bdd ctest case. Go 1.24+ is a test-only dependency. Without it CMake skips bdd, and NESSO_REQUIRE_BDD=1 turns that into a configure error (CI sets it).

Unit, integration, and functional tests are separate ctest labels. CI runs unit and integration in one job per lane. Functional shares that job on gcc Release, Clang, and arm64, and has its own gcc Debug job:

ctest --test-dir build/Debug -L unit
ctest --test-dir build/Debug -L integration
ctest --test-dir build/Debug -L functional

bdd is the test name. ctest -L bdd selects nothing.

Development

Local gate, before pushing:

bash scripts/lint
bash scripts/actionlint
bash scripts/zizmor
./scripts/code-coverage conan/profiles/code-coverage

See .github/workflows/ci.yml for lint, clang-tidy, and cppcheck, the gcc Release, gcc Debug, Clang, and arm64 builds, unit, integration, and functional tests, coverage, and the fp32 determinism gate. The coverage job publishes the cleaned lcov trace to Codecov on pull requests and pushes to main. The README badge reads that report. AFL++ fuzz-test runs on pushes to main and nightly; pull requests are fuzzed by ClusterFuzzLite. The pipeline runs on pull requests, on pushes to main, and nightly. Require the CI gate check (ci-gate in that workflow) instead of listing every job. .github/workflows/release-drafter.yml drafts the next release from version in conanfile.py. Publishing the vX.Y.Z draft creates the tag, and tag v* publishes via .github/workflows/release.yml. Weekly CodeQL (c-cpp, build-mode: none) and OpenSSF Scorecard run on main.

Benchmark commands are in benchmarks.md. The embedding gate is in determinism.md.