Skip to content

README.md

Latest commit

 

History

History
170 lines (124 loc) · 4.51 KB

README.md

File metadata and controls

170 lines (124 loc) · 4.51 KB
Raw

C++ Tests

This directory contains standalone C++ tests and benchmarks. Build artifacts are produced under tests/cpp/build.

Test Organization

tests/cpp/
├── unit/           # GoogleTest sources
│   ├── cuda/      # CUDA/cuBLAS tests
│   ├── memory/    # Memory operation tests (sources only unless wired in CMake)
│   ├── network/   # Network/messaging tests (sources only unless wired in CMake)
│   ├── backend/   # Backend scheduling/dispatch tests
│   ├── worker/    # Worker/XtGemm tests
│   └── zerocopy/  # Zero-copy buffer tests
│
├── bench/          # Google Benchmark sources
│   ├── cuda/      # CUDA benchmarks
│   └── zerocopy/  # Zero-copy benchmarks
│
└── integration/   # Integration tests

Note: Only targets explicitly listed in tests/cpp/CMakeLists.txt are built. The catalog below reflects the current executable targets.

Build Options

Default CMake behavior:

  • ENABLE_CUDA_TESTS=ON (CUDA/cuBLAS tests)
  • ENABLE_XTGEMM_TESTS=OFF (XtGemm worker tests + CUDA benchmarks)
  • ENABLE_GREEN_CTX_TESTS=OFF (green context runtime tests)
  • ENABLE_ZEROCOPY_TESTS=OFF (zerocopy tests + benchmarks)

The Docker image enables all suites:

cmake -S tests/cpp -B tests/cpp/build \
  -DENABLE_CUDA_TESTS=ON \
  -DENABLE_XTGEMM_TESTS=ON \
  -DENABLE_GREEN_CTX_TESTS=ON \
  -DENABLE_ZEROCOPY_TESTS=ON
cmake --build tests/cpp/build -j

Prerequisites / Constraints

  • CUDA tests: require CUDA toolkit + runtime.
  • XtGemm/green-context tests and benchmarks: require CUDA driver API availability and compatible GPU support (CUDA driver 12.5+; green contexts use 2-SM granularity on CC 8.x and 8-SM granularity on CC 9.0+).
  • Zerocopy tests/benchmarks: require protobuf generation, Torch, and CUDA for the pinned-pool test.

Test & Benchmark Catalog (Executable Targets)

Unit / Worker (GoogleTest)

  • test_worker_base (unit/worker)
  • test_green_trace_parser (unit/worker)

Unit / Backend (GoogleTest)

  • test_dispatch_gate (unit/backend)

Unit / Intercept (GoogleTest)

  • test_gemm_args_layout (unit/intercept) — GemmArgs layout check (#48)

Unit / Checkpoint (GoogleTest)

  • test_checkpoint_multifile (unit/checkpoint) — multi-file ReadCheckpoint consistency check (#49)

CUDA/cuBLAS Tests (GoogleTest)

  • test_cublas_hostalloc_direct
  • test_cublas_hostregister_posix
  • test_cublas_error15_repro

XtGemm Worker Tests (optional, GoogleTest)

  • test_xtgemm_worker
  • test_green_context_runtime (ENABLE_GREEN_CTX_TESTS=ON; requires CUDA driver 12.5+)

Integration Tests (GoogleTest)

  • test_barrier_integration

Zerocopy Tests (optional, GoogleTest)

  • test_aligned_buffer_pool
  • test_serialization_buffer
  • test_scatter_gather_buffer
  • test_matrix_partition
  • test_device_profile_roundtrip
  • test_profile_delta_log
  • test_device_measurement_service
  • test_device_measurement_session
  • test_cuda_pinned_pool (requires CUDA runtime)

Benchmarks (optional, Google Benchmark)

  • bench_xtgemm_worker
  • bench_green_ctx
  • bench_trace_switch
  • bench_pool_dispatch
  • bench_pool_allocation
  • bench_serialization

Running Tests

Tests are automatically built in the Docker image. You can run them via the helper script or execute binaries directly.

Run via script

# Run all test_* binaries (benchmarks are NOT included)
./tests/run_cpp_tests.sh

# Run subsets
./tests/run_cpp_tests.sh unit
./tests/run_cpp_tests.sh cuda
./tests/run_cpp_tests.sh worker

The script only runs test_* executables. Benchmarks (bench_*) must be run directly.

Run binaries directly

cd tests/cpp/build

# Example tests
./test_worker_base
./test_xtgemm_worker
./test_aligned_buffer_pool

# Example benchmarks
./bench_xtgemm_worker
./bench_serialization

Run in Docker

# Option A: exec into existing container
docker exec -it <container_id> bash -lc "cd /app && ./tests/run_cpp_tests.sh"

# Option B: one-shot run
docker run --rm --gpus=all --ulimit memlock=-1 --cap-add IPC_LOCK \
  -v "$(pwd)":/app -w /app device-emulator:latest \
  bash -lc "./tests/run_cpp_tests.sh"

Run individual binaries inside the container as needed:

docker run --rm --gpus=all --ulimit memlock=-1 device-emulator:latest \
  /app/tests/cpp/build/test_xtgemm_worker

--ulimit memlock=-1 is required by any binary that exercises the proxy server's pinned-buffer pools (zerocopy tests, measurement-session tests, xtgemm tests). See issue #59.