ci/run_bazel_test_cuda_non_rbe.sh
#!/bin/bash
# Copyright 2024 The JAX Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
# Run Bazel GPU tests without RBE. This runs two commands: single accelerator
# tests with one GPU a piece, multiaccelerator tests with all GPUS.
# If $JAXCI_BUILD_JAXLIB=false, the job requires that jaxlib, jax-cuda-plugin,
# and jax-cuda-pjrt wheels are stored inside the ../dist folder
#
# -e: abort script if one command fails
# -u: error if undefined variable used
# -x: log all commands
# -o history: record shell history
# -o allexport: export all functions and variables to be available to subscripts
set -exu -o history -o allexport

# Source default JAXCI environment variables.
source ci/envs/default.env

# Set up the build environment.
source "ci/utilities/setup_build_environment.sh"

# Run Bazel GPU tests (single accelerator and multiaccelerator tests) directly
# on the VM without RBE.
nvidia-smi
echo "Running single accelerator tests (without RBE)..."

# Set up test environment variables.
# Set the number of test jobs to min(num_cpu_cores, gpu_count * max_tests_per_gpu, total_ram_gb / 6)
# We calculate max_tests_per_gpu as memory_per_gpu_gb / 2gb
# Calculate gpu_count * max_tests_per_gpu
export gpu_count=$(nvidia-smi --query-gpu=name --format=csv,noheader | wc -l)
export memory_per_gpu_gb=$(nvidia-smi --query-gpu=memory.total --format=csv,noheader,nounits --id=0)
export memory_per_gpu_gb=$((memory_per_gpu_gb / 1024))
# Allow 2 GB of GPU RAM per test
export max_tests_per_gpu=$((memory_per_gpu_gb / 2))
export num_test_jobs=$((gpu_count * max_tests_per_gpu))

# Calculate num_cpu_cores
export num_cpu_cores=$(nproc)

# Calculate total_ram_gb / 6
export total_ram_gb=$(awk '/MemTotal/ {printf "%.0f", $2/1048576}' /proc/meminfo)
export host_memory_limit=$((total_ram_gb / 6))

if [[ $num_cpu_cores -lt $num_test_jobs ]]; then
  num_test_jobs=$num_cpu_cores
fi

if [[ $host_memory_limit -lt $num_test_jobs ]]; then
  num_test_jobs=$host_memory_limit
fi
# End of test environment variables setup.

if [[ "$JAXCI_HERMETIC_PYTHON_VERSION" == *"-nogil" ]]; then
  JAXCI_HERMETIC_PYTHON_VERSION=${JAXCI_HERMETIC_PYTHON_VERSION%-nogil}-ft
  FREETHREADED_FLAG_VALUE="yes"
else
  FREETHREADED_FLAG_VALUE="no"
fi

# Get the CUDA major version only
cuda_major_version="${JAXCI_CUDA_VERSION%%.*}"

if [[ "$JAXCI_BUILD_JAXLIB" == "wheel" ]]; then
    TEST_CONFIG="rbe_linux_x86_64_cuda$cuda_major_version"
    TEST_STRATEGY="--strategy=TestRunner=local"
    CACHE_OPTION=""
else
    TEST_CONFIG="ci_linux_x86_64_cuda$cuda_major_version"
    CACHE_OPTION="--config=ci_rbe_cache"
    TEST_STRATEGY=""
fi

# Enable forward compatibility for NVIDIA drivers older than 580.
driver_version=$(nvidia-smi --query-gpu=driver_version --format=csv,noheader | head -n 1)
driver_major_version=${driver_version%%.*}
if [[ "$driver_major_version" -lt "580" ]]; then
  echo "NVIDIA driver version ($driver_version) is older than 580."
  echo "Enabling forward compatibility."
  TEST_CONFIG="$TEST_CONFIG --@cuda_driver//:enable_forward_compatibility=true"
fi


# Don't abort the script if one command fails to ensure we run both test
# commands below.
set +e

# Runs single accelerator tests with one GPU apiece.
# It appears --run_under needs an absolute path.
# The product of the `JAX_ACCELERATOR_COUNT`` and `JAX_TESTS_PER_ACCELERATOR`
# should match the VM's CPU core count (set in `--local_test_jobs`).
bazel test --config=$TEST_CONFIG \
      $CACHE_OPTION \
      --config=use_tar_archive_files \
      --repo_env=HERMETIC_PYTHON_VERSION="$JAXCI_HERMETIC_PYTHON_VERSION" \
      --@rules_python//python/config_settings:py_freethreaded="$FREETHREADED_FLAG_VALUE" \
      --//jax:build_jaxlib=$JAXCI_BUILD_JAXLIB \
      --//jax:build_jax=$JAXCI_BUILD_JAX \
      --test_env=XLA_PYTHON_CLIENT_ALLOCATOR=platform \
      --run_under "$(pwd)/build/parallel_accelerator_execute.sh" \
      --test_output=errors \
      --test_env=JAX_ACCELERATOR_COUNT=$gpu_count \
      --test_env=JAX_TESTS_PER_ACCELERATOR=$max_tests_per_gpu \
      $TEST_STRATEGY \
      --local_test_jobs=$num_test_jobs \
      --test_env=JAX_EXCLUDE_TEST_TARGETS=PmapTest.testSizeOverflow \
      --test_tag_filters=-multiaccelerator \
      --test_env=TF_CPP_MIN_LOG_LEVEL=0 \
      --test_env=JAX_SKIP_SLOW_TESTS=true \
      --action_env=JAX_ENABLE_X64="$JAXCI_ENABLE_X64" \
      --action_env=NCCL_DEBUG=WARN \
      --color=yes \
      --config=cuda_libraries_from_stubs \
      //tests:gpu_tests //tests:backend_independent_tests \
      //tests/pallas:gpu_tests //tests/pallas:backend_independent_tests

# Store the return value of the first bazel command.
first_bazel_cmd_retval=$?

echo "Running multi-accelerator tests (without RBE)..."
# Runs multiaccelerator tests with all GPUs directly on the VM without RBE..
bazel test --config=$TEST_CONFIG \
      $CACHE_OPTION \
      --config=use_tar_archive_files \
      --repo_env=HERMETIC_PYTHON_VERSION="$JAXCI_HERMETIC_PYTHON_VERSION" \
      --@rules_python//python/config_settings:py_freethreaded="$FREETHREADED_FLAG_VALUE" \
      --//jax:build_jaxlib=$JAXCI_BUILD_JAXLIB \
      --//jax:build_jax=$JAXCI_BUILD_JAX \
      --test_env=XLA_PYTHON_CLIENT_ALLOCATOR=platform \
      --test_output=errors \
      $TEST_STRATEGY \
      --local_test_jobs=8 \
      --test_tag_filters=multiaccelerator \
      --test_env=TF_CPP_MIN_LOG_LEVEL=0 \
      --test_env=JAX_SKIP_SLOW_TESTS=true \
      --action_env=JAX_ENABLE_X64="$JAXCI_ENABLE_X64" \
      --action_env=NCCL_DEBUG=WARN \
      --color=yes \
      --config=cuda_libraries_from_stubs \
      //tests:gpu_tests //tests/pallas:gpu_tests

# Store the return value of the second bazel command.
second_bazel_cmd_retval=$?

# Exit with failure if either command fails.
if [[ $first_bazel_cmd_retval -ne 0 ]]; then
  exit $first_bazel_cmd_retval
elif [[ $second_bazel_cmd_retval -ne 0 ]]; then
  exit $second_bazel_cmd_retval
else
  exit 0
fi