summaryrefslogtreecommitdiffstats
path: root/bin/cmakehdf5
blob: bdd724f4a1404c57cae36075f62b2bf17fd360ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
#!/bin/sh
echo "Deprecated: This will be removed in a future release"
# Build and Test HDF5 using cmake.

# Copyright: The HDF Group, 2012-14

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

# 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_java=-DHDF5_BUILD_JAVA:BOOL=OFF           # Java interface default off
build_hl_lib=-DHDF5_BUILD_HL_LIB:BOOL=ON	# High Level interface default on
build_threadsafe=-DHDF5_ENABLE_THREADSAFE:BOOL=OFF  # Threadsafe feature default off
build_testing=-DBUILD_TESTING:BOOL=ON		# Build tests default on
build_test_shell=-DTEST_SHELL_SCRIPTS:BOOL=ON   # Run shell script 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
njobs=""					# number of jobs (commands) to
						# run simultaneously; default is
						# value from $MAKE if defined,
						# otherwise none (1)

#=============
# 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-java | --disable-java:
    enable or disable Java API. Default is off.
  --enable-hl | --disable-hl:
    enable or disable high level API. Default is on.
  --enable-threadsafe | --disable-threadsafe:
    enable or disable threadsafe feature. Default is off
  --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.
  --njobs=<-j N>:
    number of jobs (commands) to run simultaneously; default is value from
    $MAKE if defined, otherwise none
  --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
	    # These steps were a kludge. Need proper support from Cmake engineering.
	    echo Darwin install step needs proper implementation. Quit.
	    return 1
	    #
	    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

# Initialize njobs if $MAKE is defined
if [ -n "$MAKE" ]; then
    # assume all arguments are for --jobs
    njobs=`echo $MAKE | cut -s -d' ' -f2-`
fi

# Parse Cmake configure options
# --enable-XXX or --disable-XXX will enable or disable feature XXX.
# XXX can be:
# fortran	Fortran interface
# cxx		C++ interface
# java          Java 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-java)
            build_java=-DHDF5_BUILD_JAVA:BOOL=ON
	    ;;
        --disable-java)
            build_java=-DHDF5_BUILD_JAVA: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-threadsafe)
	    build_threadsafe=-DHDF5_ENABLE_THREADSAFE:BOOL=ON
	    ;;
	--disable-threadsafe)
	    build_threadsafe=-DHDF5_ENABLE_THREADSAFE: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
	    ;;
	--enable-shell-testing)
	    build_test_shell=-DTEST_SHELL_SCRIPTS:BOOL=ON
	    ;;
	--disable-shell-testing)
	    build_test_shell=-DTEST_SHELL_SCRIPTS: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
	    ;;
	--njobs=*)
	    njobs=`echo $1 | cut -d= -f2-`
	    ;;
	--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_java \
    $build_hl_lib \
    $build_threadsafe \
    $shared_lib \
    $build_testing \
    $build_test_shell \
    $build_tools \
    $with_zlib \
    $with_szlib \
    $srcdir" $configlog &&\
    cat src/$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 -- $njobs" $makelog

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

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

# The implementation of installation is incomplete (only works for linux).
# Screen it out for now till it is completed.
if false; then
#      8. Install with this command:
STEP "Install..." "INSTALL_HDF5" $installlog
fi

# save the last exit code
exit_code=$?

# Show a closing time stamp
TIMESTAMP
exit $exit_code