build_frei.sh

#!/bin/bash

# Define color variables for colored output if in interactive shell
# https://stackoverflow.com/questions/5947742/how-to-change-the-output-color-of-echo-in-linux
if [ "${-#*i}" == "$-" ]; then
    # Reset
    Color_Off='\033[0m'       # Text Reset

    # Regular Colors
    Black='\033[0;30m'        # Black
    Red='\033[0;31m'          # Red
    Green='\033[0;32m'        # Green
    Yellow='\033[0;33m'       # Yellow
    Blue='\033[0;34m'         # Blue
    Purple='\033[0;35m'       # Purple
    Cyan='\033[0;36m'         # Cyan
    White='\033[0;37m'        # White

    # Bold
    BBlack='\033[1;30m'       # Black
    BRed='\033[1;31m'         # Red
    BGreen='\033[1;32m'       # Green
    BYellow='\033[1;33m'      # Yellow
    BBlue='\033[1;34m'        # Blue
    BPurple='\033[1;35m'      # Purple
    BCyan='\033[1;36m'        # Cyan
    BWhite='\033[1;37m'       # White

    # Underline
    UBlack='\033[4;30m'       # Black
    URed='\033[4;31m'         # Red
    UGreen='\033[4;32m'       # Green
    UYellow='\033[4;33m'      # Yellow
    UBlue='\033[4;34m'        # Blue
    UPurple='\033[4;35m'      # Purple
    UCyan='\033[4;36m'        # Cyan
    UWhite='\033[4;37m'       # White

    # Background
    On_Black='\033[40m'       # Black
    On_Red='\033[41m'         # Red
    On_Green='\033[42m'       # Green
    On_Yellow='\033[43m'      # Yellow
    On_Blue='\033[44m'        # Blue
    On_Purple='\033[45m'      # Purple
    On_Cyan='\033[46m'        # Cyan
    On_White='\033[47m'       # White

    # High Intensity
    IBlack='\033[0;90m'       # Black
    IRed='\033[0;91m'         # Red
    IGreen='\033[0;92m'       # Green
    IYellow='\033[0;93m'      # Yellow
    IBlue='\033[0;94m'        # Blue
    IPurple='\033[0;95m'      # Purple
    ICyan='\033[0;96m'        # Cyan
    IWhite='\033[0;97m'       # White

    # Bold High Intensity
    BIBlack='\033[1;90m'      # Black
    BIRed='\033[1;91m'        # Red
    BIGreen='\033[1;92m'      # Green
    BIYellow='\033[1;93m'     # Yellow
    BIBlue='\033[1;94m'       # Blue
    BIPurple='\033[1;95m'     # Purple
    BICyan='\033[1;96m'       # Cyan
    BIWhite='\033[1;97m'      # White

    # High Intensity backgrounds
    On_IBlack='\033[0;100m'   # Black
    On_IRed='\033[0;101m'     # Red
    On_IGreen='\033[0;102m'   # Green
    On_IYellow='\033[0;103m'  # Yellow
    On_IBlue='\033[0;104m'    # Blue
    On_IPurple='\033[0;105m'  # Purple
    On_ICyan='\033[0;106m'    # Cyan
    On_IWhite='\033[0;107m'   # White
fi

# Default sucessful and failed build messages
MSG_DONE="${BGreen}Done${Color_Off}"
MSG_FAIL="${BRed}Fail${Color_Off}"

##################################################
###   List of FREI Source Files                ###
##################################################

SRC_FILES="                          \
    src/FREI.chpl                    \
    src/fr.chpl                      \
    src/temporal.chpl                \
    src/output.chpl                  \
    src/error.chpl                   \
    src/boundary.chpl                \
    src/frmesh.chpl                  \
    src/mapping.chpl                 \
    src/mesh.chpl                    \
    src/gmesh.chpl                   \
    src/riemann.chpl                 \
    src/dimensional.chpl             \
    src/flux.chpl                    \
    src/correction.chpl              \
    src/limiter.chpl                 \
    src/projection.chpl              \
    src/quadrature.chpl              \
    src/interpolation.chpl           \
    src/polynomials.chpl             \
    src/sourceterm.chpl              \
    src/init.chpl                    \
    src/ringleb.chpl                 \
    src/config.chpl                  \
    src/input.chpl                   \
    src/functions/inverse.chpl       \
    src/functions/determinant.chpl   \
    src/functions/sorttuple.chpl     \
    src/parameters.chpl              \
    src/testing.chpl                 "

##################################################
###   Get hashed for binary name               ###
##################################################

BUILD_DIR="./build"
BUILD_LOG_DIR="./build/buildLogs"
if [ ! -d "build" ]; then
    echo
    echo -e "Creating build directory:      $BUILD_DIR"
    mkdir -p $BUILD_DIR
fi
if [ ! -d "build/buildLogs" ]; then
    echo -e "Creating build logs directory: $BUILD_LOG_DIR"
    mkdir -p $BUILD_LOG_DIR
fi
echo -e "------------------------------------------------------------"

FREI_DIR=$(pwd)
GIT_HASH=$(git rev-parse HEAD)
GIT_HASH_SHORT=$(git rev-parse --short HEAD)
COMPILE_TIME=$(date -u +"%Y-%m-%d %H:%M:%S UTC")
GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
SOURCES_HASH=$(sha1sum $SRC_FILES | sha1sum | head -c 40)
BUILD_SCRIPT_HASH=$(sha1sum ./build_frei.sh | head -c 40)
CHANGES=""

# Check if:
# - We're compiling an unmodified commit
# - The source code changed from the base commit
# - The build script changed from the base commit
git diff --quiet HEAD $SRC_FILES; SOURCE_CHANGES=$?
git diff --quiet HEAD ./build_frei.sh; BUILD_SCRIPT_CHANGES=$?
if [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
    echo
    echo -e "Compiling unmodified FREI from"
    echo -e "   - Base Commit:" $GIT_HASH
    echo -e "   - From Branch:" $GIT_BRANCH
    echo -e "   - Build Time :" $COMPILE_TIME
elif [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -ne 0 ] ; then
    CHANGES=$CHANGES".bld-${BUILD_SCRIPT_HASH::6}"
    echo
    echo -e "Compiling FREI with ${BYellow}modified build script${Color_Off}"
    echo -e "   - Base Commit:" $GIT_HASH
    echo -e "   - From Branch:" $GIT_BRANCH
    echo -e "   - Build Time :" $COMPILE_TIME
    echo -e "Build script hash:" $BUILD_SCRIPT_HASH
elif [ $SOURCE_CHANGES -ne 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
    CHANGES=$CHANGES".src-${SOURCES_HASH::6}"
    echo
    echo -e "Compiling FREI with ${BYellow}modified sources${Color_Off} based on"
    echo -e "   - Base Commit:" $GIT_HASH
    echo -e "   - From Branch:" $GIT_BRANCH
    echo -e "   - Build Time :" $COMPILE_TIME
    echo -e "Source files hash:" $SOURCES_HASH
else
    CHANGES=$CHANGES".src-${SOURCES_HASH::6}"
    CHANGES=$CHANGES".bld-${BUILD_SCRIPT_HASH::6}"
    echo
    echo -e "Compiling FREI with ${BYellow}modified sources and build script${Color_Off}"
    echo -e "   - Base Commit:" $GIT_HASH
    echo -e "   - From Branch:" $GIT_BRANCH
    echo -e "   - Build Time :" $COMPILE_TIME
    echo -e "Build script hash:" $BUILD_SCRIPT_HASH
    echo -e "Source files hash:" $SOURCES_HASH
fi
echo -e "------------------------------------------------------------"

# Replace "/" with "_" on branch names so they can be user on file names
GIT_BRANCH=${GIT_BRANCH//\//_}
VERS_HASH="$GIT_HASH_SHORT$CHANGES"

##################################################
###   Configure Build Flags                    ###
##################################################

# Configure locale mode
FLAG_SL="--local"
FLAG_ML="--no-local"

if [[ $@ =~ --sl       ]]; then
    FLAG_LOCALE=$FLAG_SL
    BLD_LOCALE="sl";
    VER_LOCALE="${UBlue}Single Locale${Color_Off}"
elif [[ $@ =~ --ml       ]]; then
    FLAG_LOCALE=$FLAG_ML
    BLD_LOCALE="ml";
    VER_LOCALE="${UBlue}Multi Locale${Color_Off}"
else
    FLAG_LOCALE=$FLAG_SL
    BLD_LOCALE="sl";
    VER_LOCALE="${UBlue}Single Locale${Color_Off}"
fi

# Set build flag for each build type
FLAG_DBG="--warnings --warn-unstable --detailed-errors"
FLAG_DBG="--warnings --detailed-errors"
FLAG_OPT="--fast"

if [[ $@ =~ --dbg      ]]; then
    BLD_FLAG=$FLAG_DBG
    BLD_MODE="dbg"
    VER_MODE="${UBlue}Debug${Color_Off}"
elif [[ $@ =~ --opt      ]]; then
    BLD_FLAG=$FLAG_OPT
    BLD_MODE="opt"
    VER_MODE="${UBlue}Optimized${Color_Off}"
else
    BLD_FLAG=$FLAG_OPT
    BLD_MODE="opt"
    VER_MODE="${UBlue}Optimized${Color_Off}"
fi

# Configure Lapack distribution
BUILD_GENERIC="true"
BUILD_AMD="false"
BUILD_INTEL="false"
BUILD_OPENBLAS="false"

if [[ $@ =~ --noblas   ]]; then BLD_BLAS="noblas"; BUILD_NOBLAS="true";   BUILD_GENERIC="false"; fi
if [[ $@ =~ --amd      ]]; then BLD_BLAS="amd";    BUILD_AMD="true";      BUILD_GENERIC="false"; fi
if [[ $@ =~ --intel    ]]; then BLD_BLAS="mkl";    BUILD_INTEL="true";    BUILD_GENERIC="false"; fi
if [[ $@ =~ --openblas ]]; then BLD_BLAS="open";   BUILD_OPENBLAS="true"; BUILD_GENERIC="false"; fi
if [[ $@ =~ --blis     ]]; then BLD_BLAS="blis";   BUILD_BLIS="true";     BUILD_GENERIC="false"; fi
if [[ $@ =~ --generic  ]]; then BLD_BLAS="blas";   BUILD_GENERIC="true";  fi

##################################################
###   Generate binary and links names          ###
##################################################

BUILD_NAME="frei_${BLD_LOCALE}_${BLD_MODE}_${BLD_BLAS}.${VERS_HASH}"
LINK_NAME="frei_${BLD_LOCALE}_${BLD_MODE}_${BLD_BLAS}"
if [[ "$GIT_BRANCH" != *"HEAD detached"* ]]; then
    LINK_NAME="${LINK_NAME}.${GIT_BRANCH}"
fi

echo
echo BUILD DIR  = $BUILD_DIR
echo BUILD NAME = $BUILD_NAME
echo LINK  NAME = $LINK_NAME

##################################################
###   Build without BLAS/Lapack                ###
##################################################

if [[ $BUILD_NOBLAS == "true" ]]; then
    # No BLAS/LAPACK
    VER_LAPACK="${UBlue}No LAPACK${Color_Off}"

    echo
    echo -e "Building $VER_LOCALE $VER_MODE $VER_LAPACK version of Frei..."
    echo
    chpl $BLD_FLAG                                          \
        --set blasImpl=off                                  \
        --set lapackImpl=off                                \
        --main-module "FREI" $SRC_FILES                     \
        -o $BUILD_DIR/$BUILD_NAME                           \
        2>&1 | tee $BUILD_LOG_DIR/$BUILD_NAME.log
    if [ ${PIPESTATUS[0]} -eq 0 ]; then
        # Short link with build version specs only
        ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/${LINK_NAME%%\.*}

        # Longer link with branch name if not a detached HEAD
        if [[ "$GIT_BRANCH" != *"HEAD detached"* ]]; then
            if [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
                # Link with branch name if code and build scripts unchanged
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME
            else
                # Link with branch name and "-alpha" for edited code or build script
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME-alpha
            fi
        fi

        echo
        echo -e $MSG_DONE
    else
        echo
        echo -e $MSG_FAIL
    fi
    echo -e "------------------------------------------------------------"
fi

##################################################
###   System native BLAS/Lapack based build    ###
##################################################

if [[ $BUILD_GENERIC == "true" ]]; then
    # System BLAS/LAPACK
    VER_LAPACK="${UBlue}System LAPACK${Color_Off}"
    #PATH_TO_LIBGFORTRAN="/usr/lib64"
    #PATH_TO_BLAS_DIR="/usr/include"
    #PATH_TO_BLAS_LIBS="/usr/lib64/blas"
    #PATH_TO_LAPACK_INCLUDE_DIR="/usr/include"
    #PATH_TO_LAPACK_BINARIES="/usr/lib64/lapack"

    echo
    echo -e "Building $VER_LOCALE $VER_MODE $VER_LAPACK version of Frei..."
    echo
    chpl $FLAG_LOCALE $BLD_FLAG                             \
        -I$PATH_TO_BLAS_DIR                                 \
        -L$PATH_TO_BLAS_LIBS -lcblas                        \
        -I$PATH_TO_LAPACK_INCLUDE_DIR                       \
        -L$PATH_TO_LAPACK_BINARIES -llapacke                \
        --main-module "FREI" $SRC_FILES                     \
        -o $BUILD_DIR/$BUILD_NAME                           \
        2>&1 | tee $BUILD_LOG_DIR/$BUILD_NAME.log
    if [ ${PIPESTATUS[0]} -eq 0 ]; then
        # Short link with build version specs only
        ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/${LINK_NAME%%\.*}

        # Longer link with branch name if not a detached HEAD
        if [[ "$GIT_BRANCH" != *"HEAD detached"* ]]; then
            if [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
                # Link with branch name if code and build scripts unchanged
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME
            else
                # Link with branch name and "-alpha" for edited code or build script
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME-alpha
            fi
        fi

        echo
        echo -e $MSG_DONE
    else
        echo
        echo -e $MSG_FAIL
    fi
    echo -e "------------------------------------------------------------"
fi


##################################################
###   OpenBLAS based build                     ###
##################################################

if [[ $BUILD_OPENBLAS == "true" ]]; then
    # OpenBLAS libraries
    VER_LAPACK="${UBlue}OpenBLAS${Color_Off}"
    #PATH_TO_LIBGFORTRAN="/usr/lib64"
    #PATH_TO_OPENBLAS_DIR="/usr/include/openblas"
    #PATH_TO_OPENBLAS_LIBS="/usr/lib64/openblas-serial"

    echo
    echo -e "Building $VER_LOCALE $VER_MODE $VER_LAPACK version of Frei..."
    echo
    chpl $FLAG_LOCALE $BLD_FLAG                             \
        -I$PATH_TO_OPENBLAS_DIR                             \
        -L$PATH_TO_OPENBLAS_LIBS -lopenblas                 \
        --main-module "FREI" $SRC_FILES                     \
        -o $BUILD_DIR/$BUILD_NAME                           \
        2>&1 | tee $BUILD_LOG_DIR/$BUILD_NAME.log
    if [ ${PIPESTATUS[0]} -eq 0 ]; then
        # Short link with build version specs only
        ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/${LINK_NAME%%\.*}

        # Longer link with branch name if not a detached HEAD
        if [[ "$GIT_BRANCH" != *"HEAD detached"* ]]; then
            if [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
                # Link with branch name if code and build scripts unchanged
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME
            else
                # Link with branch name and "-alpha" for edited code or build script
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME-alpha
            fi
        fi

        echo
        echo -e $MSG_DONE
    else
        echo
        echo -e $MSG_FAIL
    fi
    echo -e "------------------------------------------------------------"
fi

##################################################
###   BLIS based build                         ###
##################################################

if [[ $BUILD_BLIS == "true" ]]; then
    # BLIS libraries
    VER_LAPACK="${UBlue}BLIS${Color_Off}"
    # echo "Bulding Blis"; ./configure --enable-cblas auto; make showconfig; make -j; make check -j; sudo make install
    #PATH_TO_LIBGFORTRAN="/usr/lib64"
    #PATH_TO_BLIS_DIR="/usr/local/include/blis"
    #PATH_TO_BLIS_LIBS="/usr/local/lib"
    #PATH_TO_LAPACK_INCLUDE_DIR="/usr/include"
    #PATH_TO_LAPACK_BINARIES="/usr/lib64/lapack"

    echo
    echo -e "Building $VER_LOCALE $VER_MODE $VER_LAPACK version of Frei..."
    echo
    chpl $FLAG_LOCALE $BLD_FLAG                             \
        -I$PATH_TO_BLIS_DIR                                 \
        -L$PATH_TO_BLIS_LIBS -lblis                         \
        -I$PATH_TO_LAPACK_INCLUDE_DIR                       \
        -L$PATH_TO_LAPACK_BINARIES -llapacke                \
        --main-module "FREI" $SRC_FILES                     \
        -o $BUILD_DIR/$BUILD_NAME                           \
        2>&1 | tee $BUILD_LOG_DIR/$BUILD_NAME.log
    if [ ${PIPESTATUS[0]} -eq 0 ]; then
        # Short link with build version specs only
        ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/${LINK_NAME%%\.*}

        # Longer link with branch name if not a detached HEAD
        if [[ "$GIT_BRANCH" != *"HEAD detached"* ]]; then
            if [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
                # Link with branch name if code and build scripts unchanged
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME
            else
                # Link with branch name and "-alpha" for edited code or build script
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME-alpha
            fi
        fi

        echo
        echo -e $MSG_DONE
    else
        echo
        echo -e $MSG_FAIL
    fi
    echo -e "------------------------------------------------------------"
fi

##################################################
###   Intel MKL based Build                    ###
##################################################

if [[ $BUILD_INTEL == "true" ]]; then
    # Intel Libraries
    VER_LAPACK="${UBlue}Intel MKL${Color_Off}"
    #PATH_TO_INTEL_LIBGFORTRAN="/opt/intel/oneapi/mkl/latest/lib/intel64"
    PATH_TO_MKL_INCLUDES="/opt/intel/oneapi/mkl/latest/include"
    PATH_TO_MKL_LIBS="/opt/intel/oneapi/mkl/latest/lib/intel64"

    echo
    echo -e "Building $VER_LOCALE $VER_MODE $VER_LAPACK version of Frei..."
    echo
    chpl $FLAG_LOCALE $BLD_FLAG                             \
        --set blasImpl=mkl                                  \
        --set lapackImpl=mkl                                \
        -I$PATH_TO_MKL_INCLUDES                             \
        -L$PATH_TO_MKL_LIBS                                 \
        -lmkl_intel_lp64 -lmkl_sequential -lmkl_core        \
        -lpthread -lm -ld                                   \
        --main-module "FREI" $SRC_FILES                     \
        -o $BUILD_DIR/$BUILD_NAME                           \
        2>&1 | tee $BUILD_LOG_DIR/$BUILD_NAME.log
    if [ ${PIPESTATUS[0]} -eq 0 ]; then
        # Short link with build version specs only
        ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/${LINK_NAME%%\.*}

        # Longer link with branch name if not a detached HEAD
        if [[ "$GIT_BRANCH" != *"HEAD detached"* ]]; then
            if [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
                # Link with branch name if code and build scripts unchanged
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME
            else
                # Link with branch name and "-alpha" for edited code or build script
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME-alpha
            fi
        fi

        echo
        echo -e $MSG_DONE
    else
        echo
        echo -e $MSG_FAIL
    fi
    echo -e "------------------------------------------------------------"
fi

##################################################
###   AMD AOCL LibM based Build                ###
##################################################

if [[ $BUILD_AMD == "true" ]]; then
    # AMD Libraries
    VER_LAPACK="${UBlue}AMD AOCL LibM${Color_Off}"
    #PATH_TO_AMD_LIBGFORTRAN="/opt/AMD/aocl/aocl-linux-aocc-4.0/lib"
    #PATH_TO_AMD_INCLUDES="/opt/AMD/aocl/aocl-linux-aocc-4.0/include"
    #PATH_TO_AMD_LIBS="/opt/AMD/aocl/aocl-linux-aocc-4.0/lib"
    PATH_TO_AMD_INCLUDES="/opt/AMD/aocl/aocl-linux-gcc-4.0/include"
    PATH_TO_AMD_LIBS="/opt/AMD/aocl/aocl-linux-gcc-4.0/lib"
    #PATH_TO_LAPACK_INCLUDE_DIR="/usr/include"
    #PATH_TO_LAPACK_BINARIES="/usr/lib64/lapack"

    echo
    echo -e "Building $VER_LOCALE $VER_MODE $VER_LAPACK version of Frei..."
    echo
    chpl $FLAG_LOCALE $BLD_FLAG                             \
        -I$PATH_TO_AMD_INCLUDES                             \
        -L$PATH_TO_AMD_LIBS -lblis -lamdlibm -lamdlibm      \
        -I$PATH_TO_LAPACK_INCLUDE_DIR                       \
        -L$PATH_TO_LAPACK_BINARIES -llapacke                \
        --main-module "FREI" $SRC_FILES                     \
        -o $BUILD_DIR/$BUILD_NAME                           \
        2>&1 | tee $BUILD_LOG_DIR/$BUILD_NAME.log
    if [ ${PIPESTATUS[0]} -eq 0 ]; then
        # Short link with build version specs only
        ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/${LINK_NAME%%\.*}

        # Longer link with branch name if not a detached HEAD
        if [[ "$GIT_BRANCH" != *"HEAD detached"* ]]; then
            if [ $SOURCE_CHANGES -eq 0 ] && [ $BUILD_SCRIPT_CHANGES -eq 0 ] ; then
                # Link with branch name if code and build scripts unchanged
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME
            else
                # Link with branch name and "-alpha" for edited code or build script
                ln -srf $BUILD_DIR/$BUILD_NAME $BUILD_DIR/$LINK_NAME-alpha
            fi
        fi

        echo
        echo -e $MSG_DONE
    else
        echo
        echo -e $MSG_FAIL
    fi
    echo -e "------------------------------------------------------------"
fi