build_metal.sh

#!/bin/bash

set -eo pipefail

# Function to display help
show_help() {
    echo "Usage: $0 [options]..."
    echo "  -h, --help                       Show this help message."
    echo "  -e, --export-compile-commands    Enable CMAKE_EXPORT_COMPILE_COMMANDS."
    echo "  -c, --enable-ccache              Enable ccache for the build."
    echo "  -b, --build-type build_type      Set the build type. Default is Release. Other options are Debug, RelWithDebInfo, and CI."
    echo "  -t, --trace                      Enable build time trace (clang only)."
    echo "  -a, --enable-asan                Enable AddressSanitizer."
    echo "  -m, --enable-msan                Enable MemorySanitizer."
    echo "  -s, --enable-tsan                Enable ThreadSanitizer."
    echo "  -u, --enable-ubsan               Enable UndefinedBehaviorSanitizer."
    echo "  -p, --enable-profiler            Enable Tracy profiler."
    echo "  --install-prefix                 Where to install build artifacts."
    echo "  --build-tests                    Build All Testcases."
    echo "  --build-ttnn-tests               Build ttnn Testcases."
    echo "  --build-metal-tests              Build metal Testcases."
    echo "  --build-umd-tests                Build umd Testcases."
    echo "  --build-programming-examples     Build programming examples."
    echo "  --build-tt-train                 Build tt-train."
    echo "  --build-all                      Build all optional components."
    echo "  --release                        Set the build type as Release."
    echo "  --development                    Set the build type as RelWithDebInfo."
    echo "  --debug                          Set the build type as Debug."
    echo "  --clean                          Remove build workspaces."
    echo "  --build-static-libs              Build tt_metal (not ttnn) as a static lib (BUILD_SHARED_LIBS=OFF)"
    echo "  --disable-unity-builds           Disable Unity builds"
    echo "  --disable-light-metal-trace      Disable Light Metal tracing to binary."
    echo "  --cxx-compiler-path              Set path to C++ compiler."
    echo "  --c-compiler-path                Set path to C++ compiler."
    echo "  --cpm-source-cache               Set path to CPM Source Cache."
    echo "  --ttnn-shared-sub-libs           Use shared libraries for ttnn."
    echo "  --toolchain-path                 Set path to CMake toolchain file."
    echo "  --configure-only                 Only configure the project, do not build."
}

clean() {
    echo "INFO: Removing build artifacts!"
    rm -rf build_Release* build_Debug* build_RelWithDebInfo* build built
}

# Parse CLI options
export_compile_commands="OFF"
enable_ccache="OFF"
enable_time_trace="OFF"
enable_asan="OFF"
enable_msan="OFF"
enable_tsan="OFF"
enable_ubsan="OFF"
build_type="Release"
enable_profiler="OFF"
build_tests="OFF"
build_ttnn_tests="OFF"
build_metal_tests="OFF"
build_umd_tests="OFF"
build_programming_examples="OFF"
build_tt_train="OFF"
build_static_libs="OFF"
unity_builds="ON"
light_metal_trace="ON"
build_all="OFF"
cxx_compiler_path=""
cpm_source_cache=""
c_compiler_path=""
ttnn_shared_sub_libs="OFF"
toolchain_path="cmake/x86_64-linux-clang-17-libcpp-toolchain.cmake"
configure_only="OFF"

declare -a cmake_args

OPTIONS=h,e,c,t,a,m,s,u,b:,p
LONGOPTIONS="
help
build-all
export-compile-commands
enable-ccache
enable-time-trace
enable-asan
enable-msan
enable-tsan
enable-ubsan
build-type:
enable-profiler
install-prefix:
build-tests
build-ttnn-tests
build-metal-tests
build-umd-tests
build-programming-examples
build-tt-train
build-static-libs
disable-unity-builds
disable-light-metal-trace
release
development
debug
clean
cxx-compiler-path:
cpm-source-cache:
c-compiler-path:
ttnn-shared-sub-libs
toolchain-path:
configure-only
"

# Flatten LONGOPTIONS into a comma-separated string for getopt
LONGOPTIONS=$(echo "$LONGOPTIONS" | tr '\n' ',' | sed 's/,$//')

# Parse the options
PARSED=$(getopt --options=$OPTIONS --longoptions=$LONGOPTIONS --name "$0" -- "$@")
if [[ $? -ne 0 ]]; then
    # If getopt has errors
    echo "INFO: Failed to parse arguments!"
    show_help
    exit 1
fi

eval set -- "$PARSED"
while true; do
    case "$1" in
        -h|--help)
            show_help;exit 0;;
        -e|--export-compile-commands)
            export_compile_commands="ON";unity_builds="OFF";;
        -c|--enable-ccache)
            enable_ccache="ON";;
        -t|--enable-time-trace)
            enable_time_trace="ON";;
        -a|--enable-asan)
            enable_asan="ON";;
        -m|--enable-msan)
            enable_msan="ON";;
        -s|--enable-tsan)
            enable_tsan="ON";;
        -u|--enable-ubsan)
            enable_ubsan="ON";;
        -b|--build-type)
            build_type="$2";shift;;
        -p|--enable-profiler)
            enable_profiler="ON";;
        --install-prefix)
            install_prefix="$2";shift;;
        --build-tests)
            build_tests="ON";;
        --build-ttnn-tests)
            build_ttnn_tests="ON";;
        --build-metal-tests)
            build_metal_tests="ON";;
        --build-umd-tests)
            build_umd_tests="ON";;
        --build-programming-examples)
            build_programming_examples="ON";;
        --build-tt-train)
            build_tt_train="ON";;
        --build-static-libs)
            build_static_libs="ON";;
        --build-all)
            build_all="ON";;
        --ttnn-shared-sub-libs)
            ttnn_shared_sub_libs="ON";;
        --configure-only)
            configure_only="ON";;
        --disable-unity-builds)
	    unity_builds="OFF";;
        --disable-light-metal-trace)
            light_metal_trace="OFF";;
        --cxx-compiler-path)
            cxx_compiler_path="$2";shift;;
        --cpm-source-cache)
            cpm_source_cache="$2";shift;;
        --c-compiler-path)
            c_compiler_path="$2";shift;;
        --toolchain-path)
            toolchain_path="$2";shift;;
        --release)
            build_type="Release";;
        --development)
            build_type="RelWithDebInfo";;
        --debug)
            build_type="Debug";;
        --clean)
	    clean; exit 0;;
        --)
            shift;break;;
    esac
    shift
done

# Check if there are unrecognized positional arguments left
if [[ $# -gt 0 ]]; then
    echo "ERROR: Unrecognized positional argument(s): $@"
    show_help
    exit 1
fi

# Validate the build_type
VALID_BUILD_TYPES=("Release" "Debug" "RelWithDebInfo")
if [[ ! " ${VALID_BUILD_TYPES[@]} " =~ " ${build_type} " ]]; then
    echo "ERROR: Invalid build type '$build_type'. Allowed values are Release, Debug, RelWithDebInfo."
    show_help
    exit 1
fi

build_dir="build_$build_type"

if [ "$enable_profiler" = "ON" ]; then
    build_dir="${build_dir}_tracy"
fi

install_prefix_default=$build_dir
cmake_install_prefix=${install_prefix:="${install_prefix_default}"}

# Set the python environment directory if not already set
if [ -z "$PYTHON_ENV_DIR" ]; then
    PYTHON_ENV_DIR=$(pwd)/python_env
fi

# Debug output to verify parsed options
echo "INFO: Export compile commands: $export_compile_commands"
echo "INFO: Enable ccache: $enable_ccache"
echo "INFO: Build type: $build_type"
echo "INFO: Enable time trace: $enable_time_trace"
echo "INFO: Enable AddressSanitizer: $enable_asan"
echo "INFO: Enable MemorySanitizer: $enable_msan"
echo "INFO: Enable ThreadSanitizer: $enable_tsan"
echo "INFO: Enable UndefinedBehaviorSanitizer: $enable_ubsan"
echo "INFO: Build directory: $build_dir"
echo "INFO: Install Prefix: $cmake_install_prefix"
echo "INFO: Build tests: $build_tests"
echo "INFO: Enable Unity builds: $unity_builds"
echo "INFO: TTNN Shared sub libs : $ttnn_shared_sub_libs"
echo "INFO: Enable Light Metal Trace: $light_metal_trace"

# Prepare cmake arguments
cmake_args+=("-B" "$build_dir")
cmake_args+=("-G" "Ninja")
cmake_args+=("-DCMAKE_BUILD_TYPE=$build_type")
cmake_args+=("-DCMAKE_INSTALL_PREFIX=$cmake_install_prefix")

if [ "$cxx_compiler_path" != "" ]; then
    echo "INFO: C++ compiler: $cxx_compiler_path"
    cmake_args+=("-DCMAKE_CXX_COMPILER=$cxx_compiler_path")
fi
if [ "$c_compiler_path" != "" ]; then
    echo "INFO: C compiler: $c_compiler_path"
    cmake_args+=("-DCMAKE_C_COMPILER=$c_compiler_path")
fi

if [ "$cpm_source_cache" != "" ]; then
    echo "INFO: CPM_SOURCE_CACHE: $cpm_source_cache"
    cmake_args+=("-DCPM_SOURCE_CACHE=$cpm_source_cache")
fi

if [ "$enable_ccache" = "ON" ]; then
    cmake_args+=("-DCMAKE_DISABLE_PRECOMPILE_HEADERS=TRUE")
    cmake_args+=("-DENABLE_CCACHE=TRUE")
fi

if [ "$enable_time_trace" = "ON" ]; then
    cmake_args+=("-DENABLE_BUILD_TIME_TRACE=ON")
fi

if [ "$enable_asan" = "ON" ]; then
    cmake_args+=("-DENABLE_ASAN=ON")
fi

if [ "$enable_msan" = "ON" ]; then
    cmake_args+=("-DENABLE_MSAN=ON")
fi

if [ "$enable_tsan" = "ON" ]; then
    cmake_args+=("-DENABLE_TSAN=ON")
fi

if [ "$enable_ubsan" = "ON" ]; then
    cmake_args+=("-DENABLE_UBSAN=ON")
fi

if [ "$enable_profiler" = "ON" ]; then
    cmake_args+=("-DENABLE_TRACY=ON")
fi

if [ "$export_compile_commands" = "ON" ]; then
    cmake_args+=("-DCMAKE_EXPORT_COMPILE_COMMANDS=ON")
else
    cmake_args+=("-DCMAKE_EXPORT_COMPILE_COMMANDS=OFF")
fi

if [ "$ttnn_shared_sub_libs" = "ON" ]; then
    cmake_args+=("-DENABLE_TTNN_SHARED_SUBLIBS=ON")
fi

if [ "$build_tests" = "ON" ]; then
    cmake_args+=("-DTT_METAL_BUILD_TESTS=ON")
    cmake_args+=("-DTTNN_BUILD_TESTS=ON")
fi

if [ "$build_metal_tests" = "ON" ]; then
    cmake_args+=("-DTT_METAL_BUILD_TESTS=ON")
fi

if [ "$build_ttnn_tests" = "ON" ]; then
    cmake_args+=("-DTTNN_BUILD_TESTS=ON")
fi

if [ "$build_umd_tests" = "ON" ]; then
    cmake_args+=("-DTT_UMD_BUILD_TESTS=ON")
fi

if [ "$build_programming_examples" = "ON" ]; then
    cmake_args+=("-DBUILD_PROGRAMMING_EXAMPLES=ON")
fi

if [ "$build_tt_train" = "ON" ]; then
    cmake_args+=("-DBUILD_TT_TRAIN=ON")
fi

if [ "$build_static_libs" = "ON" ]; then
    cmake_args+=("-DBUILD_SHARED_LIBS=OFF")
fi

if [ "$unity_builds" = "ON" ]; then
    cmake_args+=("-DTT_UNITY_BUILDS=ON")
else
    cmake_args+=("-DTT_UNITY_BUILDS=OFF")
fi

if [ "$light_metal_trace" = "ON" ]; then
    cmake_args+=("-DTT_ENABLE_LIGHT_METAL_TRACE=ON")
else
    cmake_args+=("-DTT_ENABLE_LIGHT_METAL_TRACE=OFF")
fi

if [ "$build_all" = "ON" ]; then
    cmake_args+=("-DTT_METAL_BUILD_TESTS=ON")
    cmake_args+=("-DTTNN_BUILD_TESTS=ON")
    cmake_args+=("-DBUILD_PROGRAMMING_EXAMPLES=ON")
    cmake_args+=("-DBUILD_TT_TRAIN=ON")
fi

# toolchain and cxx_compiler settings would conflict with eachother
# only use toolchain if not setting cxx compiler directly
if [ "$cxx_compiler_path" == "" ]; then
    echo "INFO: CMAKE_TOOLCHAIN_FILE: $toolchain_path"
    cmake_args+=("-DCMAKE_TOOLCHAIN_FILE=${toolchain_path}")
fi

# Create and link the build directory
mkdir -p $build_dir
ln -nsf $build_dir build

echo "INFO: Configuring Project"
echo "INFO: Running: cmake "${cmake_args[@]}""
cmake "${cmake_args[@]}"

# Build libraries and cpp tests
if [ "$configure_only" = "OFF" ]; then
    echo "INFO: Building Project"
    cmake --build $build_dir --target install
fi