path: root/bin/cmakehdf5

#! /bin/sh
# Build and Test HDF5 using cmake.
# Author: Allen Byrne
#         Albert Cheng
# Creation Date: Nov 2012
# Modified:
#	Changed to use the quick steps described in INSTALL_CMake.txt. (AKC 2014/1/1)

# Copyright: The HDF Group, 2012-14

# Debug Print: remove the comment hash if you want DPRINT to do echo
DPRINT=:
#DPRINT=echo

# use the ctest scripting method if --script is given
if [ "$1" != "--script" ]; then
# variable names
# The "extra" number is the step number and easier to see all logfiles in
# the sorted order of steps
progname=`basename $0`	# program name
configlog="#${progname}_1config.log"
makelog="#${progname}_2build.log"
testlog="#${progname}_3test.log"
packlog="#${progname}_4pack.log"
installlog="#${progname}_5install.log"
vflag=1		# verbose flag default to on.
config_summary=libhdf5.settings
exit_code=0

# This command should be in the source directory's bin/
# and should have invoked as "$srcdir/bin/$progname" or
# "bin/$progname". So, by striping bin/$program from $0,
# we can find $srcdir.
if [ $0 == bin/$progname ]; then
    srcdir="."		# current directory
else
    # $0 is $srdir/bin/$progname
    srcdir=`echo $0 | sed -e s%/bin/$progname\$%%`
fi
# Sanity check
if [ ! -r $srcdir/bin/$progname ]; then
    echo "encountered error while trying to find srcdir($srdir)"
    exit 1
fi

# Cmake build options
cacheinit=$srcdir/config/cmake/cacheinit.cmake
build_cpp_lib=-DHDF5_BUILD_CPP_LIB:BOOL=OFF	# C++ interface default off
build_fortran=-DHDF5_BUILD_FORTRAN:BOOL=OFF	# Fortran interface default off
build_hl_lib=-DHDF5_BUILD_HL_LIB:BOOL=ON	# High Level interface default on
build_testing=-DBUILD_TESTING:BOOL=ON		# Build tests default on
build_tools=-DHDF5_BUILD_TOOLS:BOOL=ON		# Build tools default on
with_zlib=-DHDF5_ENABLE_Z_LIB_SUPPORT=ON	# enable zlib filter default on
with_szlib=-DHDF5_ENABLE_SZIP_SUPPORT=OFF	# enables szip filter default off
szlib_path=""					# szip lib path default off
shared_lib=-DBUILD_SHARED_LIBS:BOOL=ON		# enables shared lib; default on


#=============
# Function definitions
#=============

# Show user brief help page
HELP_BRIEF()
{
cat << EOF
Usage: $progname [options]
  --help: shows details help page
EOF
}

# Show user detail help page
HELP()
{
cat << EOF
Usage: $progname [<options>]
  where options are:
  --enable-fortran | --disable-fortran:
    enable or disable fortran API. Default is off.
  --enable-cxx | --disable-cxx:
    enable or disable c++ API. Default is off.
  --enable-hl | --disable-hl:
    enable or disable high level API. Default is on.
  --enable-shared | --disable-shared:
    enable or disable shared lib. Default is on.
  --enable-tools | --disable-tools:
    enable or disable building tools. Default is on.
  --enable-testing | --disable-testing:
    enable or disable building tests. Default is on.
  --with-zlib | --with-zlib=<libpath> | --without-zlib:
    Use zlib library for external deflate I/O filter. Default is on.
  --with-szlib | --with-szlib=<libpath> | --without-szlib:
    Use szlib library for external deflate I/O filter. Default is on.
  --enable-verbose | --disable-verbose:
    enable or disable verbose output. Default is on.
  --help: shows details help page

  <libpath>: the file path to the library, expect <libpath>/lib and <libpath>/include.
EOF
}

# Display a time stamp
TIMESTAMP()
{
    echo "=====" "`date`" "====="
}


# Do one step bracketed with time stamps
# The '< /dev/null' is needed to prevent some applications like MPI
# jobs blocked for reading when they read stdin unnecessary.
# $1 is banner message to be displayed.
# $2 is command to run
# $3 is logfile name for saving output from the command
STEP()
{
    banner="$1"
    command="$2"
    logfile="$3"

    echo "$banner" with output saved in $logfile
    (TIMESTAMP; nerror=0 ;
  echo "eval $command"
  eval $command || nerror=1 ;
  TIMESTAMP; exit $nerror) < /dev/null > "$logfile" 2>&1
    if [ $? -ne 0 ]; then
  echo "error in '$banner'.  $progname aborted."
  exit 1
    fi
}


# Install the generated installation image file.  Different platform uses
# different image files.
# Linux: HDF5-<version>-Linux.sh file
# Mac OS X: Not implemented yet
# Others: Not implemented yet
INSTALL_HDF5()
{
    myos="`uname -s`"
    case "$myos" in
  Linux)
      install_file=./HDF5-${version}-Linux.sh
      $install_file  --skip-license $*
      ;;
  Darwin)		# Mac OSX DMG file
      install_file=HDF5-${version}-Darwin.dmg
      test -d hdf5 || mkdir hdf5
      basename=`basename $install_file .dmg`
      # mount the DMG file as /Volumes/$basename
      # echo 'Y' as yes for license.
      echo Y | hdiutil mount $install_file
      # copy the contents to the install location
      cp -R "/Volumes/$basename/HDF_Group" hdf5
      # unmount the DMG file
      hdiutil unmount /Volumes/$basename
      ;;
  *) 		# unknown/unsupported OS.
      echo "INSTALL_HDF5: Error--unknown/unsupported OS($myos)"
      return 1
      ;;
    esac
}


# Print logfiles.
# $*: logfiles
DUMP_LOGFILE()
{
    for x in $*; do
  if [ -f $x ]; then
      echo "=================================="
      echo "Dumping $x"
      echo "=================================="
      cat $x
      echo "==== END $x ====="
      echo
  fi
    done
}


#==========
# main
#==========

# Show a start time stamp
TIMESTAMP

# Parse Cmake configure options
# --enable-XXX or --disable-XXX will enable or disable feature XXX.
# XXX can be:
# fortran	Fortran interface
# cxx		C++ interface
# hl		Highlevel interface
# testing	Build tests
# tools		Build tools
while [ $# -gt 0 ]; do
    case "$1" in
  --enable-fortran)
      build_fortran=-DHDF5_BUILD_FORTRAN:BOOL=ON
      ;;
  --disable-fortran)
      build_fortran=-DHDF5_BUILD_FORTRAN:BOOL=OFF
      ;;
  --enable-cxx)
      build_cpp_lib=-DHDF5_BUILD_CPP_LIB:BOOL=ON
      ;;
  --disable-cxx)
      build_cpp_lib=-DHDF5_BUILD_CPP_LIB:BOOL=OFF
      ;;
  --enable-hl)
      build_hl_lib=-DHDF5_BUILD_HL_LIB:BOOL=ON
      ;;
  --disable-hl)
      build_hl_lib=-DHDF5_BUILD_HL_LIB:BOOL=OFF
      ;;
  --enable-shared)
      shared_lib=-DBUILD_SHARED_LIBS:BOOL=ON
      ;;
  --disable-shared)
      shared_lib=-DBUILD_SHARED_LIBS:BOOL=OFF
      ;;
  --enable-tools)
      build_tools=-DHDF5_BUILD_TOOLS:BOOL=ON
      ;;
  --disable-tools)
      build_tools=-DHDF5_BUILD_TOOLS:BOOL=OFF
      ;;
  --enable-testing)
      build_testing=-DBUILD_TESTING:BOOL=ON
      ;;
  --disable-testing)
      build_testing=-DBUILD_TESTING:BOOL=OFF
      ;;
  --with-zlib)
      with_zlib=-DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=ON
      ;;
  --with-zlib=*)
      xarg=`echo $1 | cut -d= -f2-`
      with_zlib="-DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=ON -DZLIB_ROOT=$xarg"
      ;;
  --without-zlib)
      with_zlib=-DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF
      ;;
  --with-szlib)
      with_szlib=-DHDF5_ENABLE_SZIP_SUPPORT:BOOL=ON
      szlib_path=""	# szlib is in default paths
      ;;
  --with-szlib=*)
      xarg=`echo $1 | cut -d= -f2-`
      with_szlib="-DHDF5_ENABLE_SZIP_SUPPORT:BOOL=ON"
      szlib_path="SZIP_INSTALL=$xarg"
      ;;
  --without-szlib)
      with_szlib=-DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF
      szlib_path=""	# reset the path
      ;;
  --enable-verbose)
      vflag=1
      ;;
  --disable-verbose)
      vflag=0
      ;;
  --help)
      # print the detail help page and exit
      HELP
      exit 0
      ;;
  *)
      echo "Unknown options: $1"
      HELP
      exit 1
      ;;
    esac
    shift
done
$DPRINT after option parsing vflag=$vflag

# Always display the brief help page
HELP_BRIEF

# Verify there is a valid hdf5 source directory present
if [ ! -d $srcdir ]; then
    echo $srcdir not found. Aborted.
    exit 1
fi

# figure out version information
vers=bin/h5vers
if [ ! -x $srcdir/$vers ]; then
    echo $srcdir/$vers not found or not executable. Aborted.
    exit 1
fi
version=`cd $srcdir; $vers`
if [ $? != 0 ]; then
    echo $vers failed. Aborted.
    exit 1
fi

# setup output of all the log files if verbose is on upon exit
trap \
"if [ $vflag -ne 0 ]; then DUMP_LOGFILE \$configlog \$makelog \$testlog \$packlog \$installlog; fi" \
0

echo Running Cmake for HDF5-${version} ...
#      4. Configure the C library, tools and tests with this command:
#         If successful, append the configure summary to the configure logfile.
STEP "Configure..." \
   "env ${szlib_path} \
    cmake \
    -C $cacheinit \
    $build_cpp_lib \
    $build_fortran \
    $build_hl_lib \
    $shared_lib \
    $build_testing \
    $build_tools \
    $with_zlib \
    $with_szlib \
    $srcdir" $configlog &&\
    cat $config_summary >> $configlog

#      5. Build the C library, tools and tests with this command:
STEP "Build the library, tools and tests, ..." "cmake --build . --config Release" $makelog

#      6. Test the C library and tools with this command:
STEP "Test the library and tools..." "ctest . -C Release" $testlog

#      7. Create an install image with this command:
STEP "Create an install image..." "cpack -C Release CPackConfig.cmake" $packlog

#      8. Install with this command:
STEP "Install..." "INSTALL_HDF5" $installlog
# save the last exit code
exit_code=$?

# Show a closing time stamp
TIMESTAMP
exit $exit_code

else
# ---------------
# older version
# ---------------

# variable names
progname=`basename $0`	# program name
cminfile="cmakemin.$$" # Cmake minimum file
cfgfile=$progname.$$	# configure file
ctest_log=ctest.log    # output of ctest script
install_log=install.log  # output of installation
$DPRINT $cfgfile

# Remove temporary generated files if exit 0
trap "rm -f $cminfile $cfgfile" 0

#=============
# Function definitions
#=============
TIMESTAMP()
{
    echo "=====" "`date`" "====="
}


#==========
# main
#==========
# Show a start time stamp
TIMESTAMP

# Explain what and where log files are.
cat <<EOF
$ctest_log: output of ctest script.
$install_log: output of installation
Log files will be stored in Testing/Temporary:
    LastConfigure_<timestamp>.log: output of configure
    LastBuild_<timestamp>.log: output of build
    LastTest_<timestamp>.log: output of testing
    LastTestsFailed_<timestamp>.log: list of failed tests

EOF

# First generate the two needed input files, the $cimnfile and $cfgfile.
# Then use ctest to use the two input files.

#==========
# create the configure file
#==========
# Create the cmake minimum required file to be used by the following
# configure file. Though not absolute needed, it is better to generate
# this file before the configure file.  Quote the EOF to preven substitution
# in the text.
#==========
#==========
cat > $cfgfile <<'EOF'
cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR)
########################################################
# This dashboard is maintained by The HDF Group
# For any comments please contact cdashhelp@hdfgroup.org
#
########################################################

set (CTEST_DASHBOARD_ROOT ${CTEST_SCRIPT_DIRECTORY})
set (CTEST_SOURCE_DIRECTORY "../hdf5")
set (CTEST_BINARY_DIRECTORY ".")
set (CTEST_CMAKE_GENERATOR "Unix Makefiles")
set (CTEST_BUILD_CONFIGURATION "Release")
set (CTEST_MAX_N 8)

# -- CDash variables
set (LOCAL_NO_SUBMIT TRUE)	# No CDash submit.
set (MODEL "Experimental")
set (CDASH_LOCAL TRUE)
set (SITE_BUILDNAME_SUFFIX "cmakehdf5")

# -- URL set for internal check, default is to not update
set (LOCAL_SKIP_UPDATE TRUE)
set (REPOSITORY_URL "http://svn.${hdfgroup_url}/hdf5/branches/hdf5_1_8")
# -- Standard build options
set (ADD_BUILD_OPTIONS "-DCMAKE_INSTALL_PREFIX:PATH=${CTEST_BINARY_DIRECTORY} -DHDF5_ALLOW_EXTERNAL_SUPPORT:STRING=\"SVN\" -DHDF5_PACKAGE_EXTLIBS:BOOL=ON")

# Use multiple CPU cores to build
include(ProcessorCount)
ProcessorCount(N)
if(NOT N EQUAL 0)
  if(N GREATER ${CTEST_MAX_N})
    set(N ${CTEST_MAX_N})
  endif(N GREATER ${CTEST_MAX_N})
  set(CTEST_BUILD_FLAGS -j${N})
  set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N})
endif()

# -----------------------------------------------------------
# -- Get environment
# -----------------------------------------------------------
  ## -- set hostname
  ## --------------------------
  find_program (HOSTNAME_CMD NAMES hostname)
  exec_program (${HOSTNAME_CMD} ARGS OUTPUT_VARIABLE HOSTNAME)
  set (CTEST_SITE "${HOSTNAME}${CTEST_SITE_EXT}")
  find_program (UNAME NAMES uname)
  macro (getuname name flag)
    exec_program ("${UNAME}" ARGS "${flag}" OUTPUT_VARIABLE "${name}")
  endmacro (getuname)

  getuname (osname -s)
  getuname (osrel  -r)
  getuname (cpu    -m)

  if (SITE_BUILDNAME_SUFFIX)
    set (CTEST_BUILD_NAME  "${osname}-${osrel}-${cpu}-${SITE_BUILDNAME_SUFFIX}")
  else (SITE_BUILDNAME_SUFFIX)
    set (CTEST_BUILD_NAME  "${osname}-${osrel}-${cpu}")
  endif (SITE_BUILDNAME_SUFFIX)
# -----------------------------------------------------------

set (BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DSITE:STRING=${CTEST_SITE} -DBUILDNAME:STRING=${CTEST_BUILD_NAME}")

#-----------------------------------------------------------------------------
# MAC machines need special option
#-----------------------------------------------------------------------------
if (APPLE)
  # Compiler choice
  execute_process(COMMAND xcrun --find cc OUTPUT_VARIABLE XCODE_CC OUTPUT_STRIP_TRAILING_WHITESPACE)
  execute_process(COMMAND xcrun --find c++ OUTPUT_VARIABLE XCODE_CXX OUTPUT_STRIP_TRAILING_WHITESPACE)
  set(ENV{CC} "${XCODE_CC}")
  set(ENV{CXX} "${XCODE_CXX}")
  # Shared fortran is not supported, build static
  set (BUILD_OPTIONS "${BUILD_OPTIONS} -DBUILD_SHARED_LIBS:BOOL=OFF -DCMAKE_ANSI_CFLAGS:STRING=-fPIC")
  set (BUILD_OPTIONS "${BUILD_OPTIONS} -DCTEST_USE_LAUNCHERS:BOOL=ON -DCMAKE_BUILD_WITH_INSTALL_RPATH:BOOL=OFF")
endif (APPLE)


# -----------------------------------------------------------
find_package (Subversion)
set (CTEST_UPDATE_COMMAND "${Subversion_SVN_EXECUTABLE}")
# -- Only clean build folder if LOCAL_CLEAR_BUILD is set
if (LOCAL_CLEAR_BUILD)
  set (CTEST_START_WITH_EMPTY_BINARY_DIRECTORY TRUE)
  if(NOT EXISTS "${CTEST_BINARY_DIRECTORY}")
    file(MAKE_DIRECTORY "${CTEST_BINARY_DIRECTORY}")
  else()
    ctest_empty_binary_directory(${CTEST_BINARY_DIRECTORY})
  endif()
endif (LOCAL_CLEAR_BUILD)

#-----------------------------------------------------------------------------
# Send the main script as a note.
list (APPEND CTEST_NOTES_FILES
  "${CMAKE_CURRENT_LIST_FILE}"
  "${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake"
  )

# Check for required variables.
foreach (req
    CTEST_CMAKE_GENERATOR
    CTEST_SITE
    CTEST_BUILD_NAME
    )
  if (NOT DEFINED ${req})
    message(FATAL_ERROR "The containing script must set ${req}")
  endif (NOT DEFINED ${req})
endforeach (req)

## -- set output to english
set($ENV{LC_MESSAGES}  "en_EN")

#-----------------------------------------------------------------------------
# Initialize the CTEST commands
#------------------------------
set (CTEST_CMAKE_COMMAND "\"${CMAKE_COMMAND}\"")
set (CTEST_CONFIGURE_COMMAND
    "${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_BUILD_CONFIGURATION} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\"")

# Print summary information.
foreach (v
    CTEST_SITE
    CTEST_BUILD_NAME
    CTEST_SOURCE_DIRECTORY
    CTEST_BINARY_DIRECTORY
    CTEST_CMAKE_GENERATOR
    CTEST_BUILD_CONFIGURATION
    CTEST_CONFIGURE_COMMAND
    CTEST_SCRIPT_DIRECTORY
    )
  set (vars "${vars}  ${v}=[${${v}}]\n")
endforeach (v)
message ("Dashboard script configuration:\n${vars}\n")

ctest_start (${MODEL} TRACK ${MODEL})
if (NOT LOCAL_SKIP_UPDATE)
  ctest_update (SOURCE "${CTEST_SOURCE_DIRECTORY}")
endif (NOT LOCAL_SKIP_UPDATE)
if(NOT res STREQUAL "0")
  message (FATAL_ERROR "Configure FAILED")
endif()
message ("Configure DONE")
configure_file(${CTEST_SOURCE_DIRECTORY}/config/cmake/CTestCustom.cmake ${CTEST_BINARY_DIRECTORY}/CTestCustom.cmake)
ctest_read_custom_files ("${CTEST_BINARY_DIRECTORY}")
ctest_configure (BUILD "${CTEST_BINARY_DIRECTORY}" RETURN_VALUE res)
if (NOT LOCAL_NO_SUBMIT)
  ctest_submit (PARTS Update Configure Notes)
endif (NOT LOCAL_NO_SUBMIT)
ctest_build (BUILD "${CTEST_BINARY_DIRECTORY}" APPEND RETURN_VALUE res)
if (NOT LOCAL_NO_SUBMIT)
  ctest_submit (PARTS Build)
endif (NOT LOCAL_NO_SUBMIT)
if(NOT res STREQUAL "0")
  message (FATAL_ERROR "Build FAILED")
endif()
message ("build DONE")
if (NOT LOCAL_SKIP_TEST)
  ctest_build (BUILD "${CTEST_BINARY_DIRECTORY}" APPEND ${ctest_test_args} RETURN_VALUE res)
  if (NOT LOCAL_NO_SUBMIT)
    ctest_submit (PARTS Test)
  endif (NOT LOCAL_NO_SUBMIT)
  if(NOT res STREQUAL "0")
    message (FATAL_ERROR "Test FAILED")
  endif()
  message ("test DONE")
endif (NOT LOCAL_SKIP_TEST)
if(NOT LOCAL_MEMCHECK_TEST)
  ##-----------------------------------------------
  ## Package the product
  ##-----------------------------------------------
  execute_process(COMMAND cpack -C ${CTEST_BUILD_CONFIGURATION} -V
    WORKING_DIRECTORY ${CTEST_BINARY_DIRECTORY}
    RESULT_VARIABLE cpackResult
    OUTPUT_VARIABLE cpackLog
    ERROR_VARIABLE cpackLog.err
  )
  file(WRITE ${CTEST_BINARY_DIRECTORY}/cpack.log "${cpackLog.err}" "${cpackLog}")
endif(NOT LOCAL_MEMCHECK_TEST)
#-----------------------------------------------------------------------------

message ("DONE")
EOF


# Run ctest
ctest -S $cfgfile -C Release -V -O $ctest_log
exit_code=$?
if [ $exit_code = 0 ]; then
    echo CTest script completed without error
else
    echo Error encountered CTest script
fi
# Using HDF5-*.sh because actual name is unavailable
install_sh=HDF5-*.sh
echo installing with $install_sh ...
./$install_sh --skip-license > $install_log
exit_code=$?
if [ $exit_code = 0 ]; then
    echo Complete without error
else
    echo Error encountered
fi
TIMESTAMP
exit $exit_code

fi