#!/bin/bash # Modifications Copyright (c) 2024-2026 Advanced Micro Devices, Inc. # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. set -eo pipefail # Ensure the script is being executed in its containing directory cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"; # Script defaults VERBOSE=${VERBOSE:-} HOST_COMPILER=${CXX:-amdclang++} # $CXX if set, otherwise `amdclang++` CXX_STANDARD=17 # Mirror hipcc's platform detection: HIP_PLATFORM=nvidia uses nvcc, # everything else (including unset) uses amdclang++ directly. if [ "${HIP_PLATFORM:-amd}" = "nvidia" ] || [ "${HIP_PLATFORM:-amd}" = "nvcc" ]; then CUDA_COMPILER=${CUDACXX:-nvcc} else CUDA_COMPILER=${CUDACXX:-amdclang++} fi CUDA_ARCHS= # Empty, use presets by default. GLOBAL_CMAKE_OPTIONS=() DISABLE_CUB_BENCHMARKS= # Enable to force-disable building CUB benchmarks. CONFIGURE_ONLY=false # Check if the correct number of arguments has been provided function usage { echo "Usage: $0 [OPTIONS]" echo echo "The PARALLEL_LEVEL environment variable controls the amount of build parallelism. Default is the number of cores." echo echo "Options:" echo " -v/-verbose: enable shell echo for debugging" echo " -configure: Only run cmake to configure, do not build or test." echo " -cuda: CUDA compiler (Defaults to \$CUDACXX if set, otherwise nvcc)" echo " -cxx: Host compiler (Defaults to \$CXX if set, otherwise g++)" echo " -std: CUDA/C++ standard (Defaults to 17)" echo " -arch: Target CUDA arches, e.g. \"60-real;70;80-virtual\" (Defaults to value in presets file)" echo " -cmake-options: Additional options to pass to CMake" echo echo "Examples:" echo " $ PARALLEL_LEVEL=8 $0" echo " $ PARALLEL_LEVEL=8 $0 -cxx g++-9" echo " $ $0 -cxx clang++-8" echo " $ $0 -configure -arch=gfx90a" echo " $ $0 -cxx g++-8 -std 14 -arch gfx90a -v -cuda /opt/rocm/bin/hipcc" echo " $ $0 -cmake-options \"-DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS=-Wfatal-errors\"" exit 1 } # Parse options # Copy the args into a temporary array, since we will modify them and # the parent script may still need them. args=("$@") while [ "${#args[@]}" -ne 0 ]; do case "${args[0]}" in -v | --verbose | -verbose) VERBOSE=1; args=("${args[@]:1}");; -configure) CONFIGURE_ONLY=true; args=("${args[@]:1}");; -cxx) HOST_COMPILER="${args[1]}"; args=("${args[@]:2}");; -std) CXX_STANDARD="${args[1]}"; args=("${args[@]:2}");; -cuda) CUDA_COMPILER="${args[1]}"; args=("${args[@]:2}");; -arch) CUDA_ARCHS="${args[1]}"; args=("${args[@]:2}");; -disable-benchmarks) DISABLE_CUB_BENCHMARKS=1; args=("${args[@]:1}");; -cmake-options) if [ -n "${args[1]}" ]; then IFS=' ' read -ra split_args <<< "${args[1]}" GLOBAL_CMAKE_OPTIONS+=("${split_args[@]}") args=("${args[@]:2}") else echo "Error: No arguments provided for -cmake-options" usage exit 1 fi ;; -h | -help | --help) usage ;; *) echo "Unrecognized option: ${args[0]}"; usage ;; esac done # Convert to full paths: HOST_COMPILER=$(which ${HOST_COMPILER}) CUDA_COMPILER=$(which ${CUDA_COMPILER}) if [[ -n "${CUDA_ARCHS}" ]]; then GLOBAL_CMAKE_OPTIONS+=("-DCMAKE_HIP_ARCHITECTURES=${CUDA_ARCHS}") fi if [ $VERBOSE ]; then set -x fi # Begin processing unsets after option parsing set -u readonly PARALLEL_LEVEL=${PARALLEL_LEVEL:=$(nproc)} if [ -z ${CCCL_BUILD_INFIX+x} ]; then CCCL_BUILD_INFIX="" fi # Presets will be configured in this directory: BUILD_DIR="../build/${CCCL_BUILD_INFIX}" # The most recent build will always be symlinked to cccl/build/latest mkdir -p $BUILD_DIR rm -f ../build/latest ln -sf $BUILD_DIR ../build/latest # Now that BUILD_DIR exists, use readlink to canonicalize the path: BUILD_DIR=$(readlink -f "${BUILD_DIR}") # Prepare environment for CMake: export CMAKE_BUILD_PARALLEL_LEVEL="${PARALLEL_LEVEL}" export CTEST_PARALLEL_LEVEL="1" export CXX="${HOST_COMPILER}" export CUDACXX="${CUDA_COMPILER}" export CUDAHOSTCXX="${HOST_COMPILER}" export CXX_STANDARD # Set LLVM_PATH so COMGR finds the correct clang binary for GCC detection export LLVM_PATH=/opt/rocm/lib/llvm source ./pretty_printing.sh print_environment_details() { begin_group "⚙️ Environment Details" echo "pwd=$(pwd)" print_var_values \ BUILD_DIR \ CXX_STANDARD \ CXX \ CUDACXX \ CUDAHOSTCXX \ HIPCC_VERSION \ CMAKE_BUILD_PARALLEL_LEVEL \ CTEST_PARALLEL_LEVEL \ CCCL_BUILD_INFIX \ GLOBAL_CMAKE_OPTIONS \ TBB_ROOT echo "Current commit is:" git log -1 || echo "Not a repository" if command -v amd-smi &> /dev/null; then amd-smi else echo "amd-smi not found" fi if command -v cmake &> /dev/null; then cmake --version else echo "cmake not found" fi if command -v ctest &> /dev/null; then ctest --version else echo "ctest not found" fi end_group "⚙️ Environment Details" } fail_if_no_gpu() { if ! amd-smi &> /dev/null; then echo "Error: No AMD GPU detected. Please ensure you have an AMD GPU installed and the drivers are properly configured." >&2 exit 1 fi } function print_test_time_summary() { ctest_log=${1} if [ -f ${ctest_log} ]; then begin_group "⏱️ Longest Test Steps" # Only print the full output in CI: if [ -n "${GITHUB_ACTIONS:-}" ]; then cmake -DLOGFILE=${ctest_log} -P ../cmake/PrintCTestRunTimes.cmake else # `|| :` to avoid `set -o pipefail` from triggering when `head` closes the pipe before `cmake` finishes. # Otherwise the script will exit early with status 141 (SIGPIPE). cmake -DLOGFILE=${ctest_log} -P ../cmake/PrintCTestRunTimes.cmake | head -n 15 || : fi end_group "⏱️ Longest Test Steps" fi } function configure_preset() { local BUILD_NAME=$1 local PRESET=$2 local CMAKE_OPTIONS=$3 local GROUP_NAME="🛠️ CMake Configure ${BUILD_NAME}" pushd .. > /dev/null run_command "$GROUP_NAME" cmake --preset=$PRESET --log-level=VERBOSE $CMAKE_OPTIONS "${GLOBAL_CMAKE_OPTIONS[@]}" status=$? popd > /dev/null if $CONFIGURE_ONLY; then echo "${BUILD_NAME} configuration complete:" echo " Exit code: ${status}" echo " CMake Preset: ${PRESET}" echo " CMake Options: ${CMAKE_OPTIONS}" echo " Build Directory: ${BUILD_DIR}/${PRESET}" exit $status fi return $status } function build_preset() { local BUILD_NAME=$1 local PRESET=$2 local green="1;32" local red="1;31" local GROUP_NAME="🏗️ Build ${BUILD_NAME}" if $CONFIGURE_ONLY; then return 0 fi local preset_dir="${BUILD_DIR}/${PRESET}" local sccache_json="${preset_dir}/sccache_stats.json" source "./sccache_stats.sh" "start" pushd .. > /dev/null run_command "$GROUP_NAME" cmake --build --preset=$PRESET -v status=$? popd > /dev/null sccache --show-adv-stats --stats-format=json > "${sccache_json}" minimal_sccache_stats=$(source "./sccache_stats.sh" "end") # Only print detailed stats in actions workflow if [ -n "${GITHUB_ACTIONS:-}" ]; then begin_group "💲 sccache stats" echo "${minimal_sccache_stats}" sccache -s end_group begin_group "🥷 ninja build times" echo "The "weighted" time is the elapsed time of each build step divided by the number of tasks that were running in parallel. This makes it an excellent approximation of how "important" a slow step was. A link that is entirely or mostly serialized will have a weighted time that is the same or similar to its elapsed time. A compile that runs in parallel with 999 other compiles will have a weighted time that is tiny." ./ninja_summary.py -C ${BUILD_DIR}/${PRESET} || echo "Warning: ninja_summary.py failed to execute properly." end_group else echo $minimal_sccache_stats fi return $status } function test_preset() { local BUILD_NAME=$1 local PRESET=$2 local GPU_REQUIRED=${3:-true} if $CONFIGURE_ONLY; then return 0 fi if $GPU_REQUIRED; then fail_if_no_gpu fi local GROUP_NAME="🚀 Test ${BUILD_NAME}" local preset_dir="${BUILD_DIR}/${PRESET}" local ctest_log="${preset_dir}/ctest.log" pushd .. > /dev/null run_command "$GROUP_NAME" ctest --output-log "${ctest_log}" --preset=$PRESET status=$? popd > /dev/null print_test_time_summary ${ctest_log} return $status } function configure_and_build_preset() { local BUILD_NAME=$1 local PRESET=$2 local CMAKE_OPTIONS=$3 configure_preset "$BUILD_NAME" "$PRESET" "$CMAKE_OPTIONS" if ! $CONFIGURE_ONLY; then build_preset "$BUILD_NAME" "$PRESET" fi }