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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
|
# Copyright 2013-2023 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import os
import re
import shutil
import llnl.util.tty as tty
from spack.package import *
class Hdf5(CMakePackage):
"""HDF5 is a data model, library, and file format for storing and managing
data. It supports an unlimited variety of datatypes, and is designed for
flexible and efficient I/O and for high volume and complex data.
"""
homepage = "https://portal.hdfgroup.org"
url = "https://support.hdfgroup.org/ftp/HDF5/releases/hdf5-1.10/hdf5-1.10.8/src/hdf5-1.10.8.tar.gz"
list_url = "https://support.hdfgroup.org/ftp/HDF5/releases"
list_depth = 3
git = "https://github.com/HDFGroup/hdf5.git"
maintainers("lrknox", "brtnfld", "byrnHDF", "gheber", "hyoklee", "lkurz")
tags = ["e4s", "windows"]
executables = ["^h5cc$", "^h5pcc$"]
test_requires_compiler = True
# The 'develop' version is renamed so that we could uninstall (or patch) it
# without affecting other develop version.
version("develop-1.15", branch="develop")
version("develop-1.14", branch="hdf5_1_14")
version("develop-1.12", branch="hdf5_1_12")
version("develop-1.10", branch="hdf5_1_10")
version("develop-1.8", branch="hdf5_1_8")
# Odd versions are considered experimental releases
# Note: These are still required to build some VOL adapters, but even releases should be
# preferred.
version("1.13.3", sha256="83c7c06671f975cee6944b0b217f95005faa55f79ea5532cf4ac268989866af4")
version("1.13.2", sha256="01643fa5b37dba7be7c4db6bbf3c5d07adf5c1fa17dbfaaa632a279b1b2f06da")
# Even versions are maintenance versions
version(
"1.14.1-2",
sha256="cbe93f275d5231df28ced9549253793e40cd2b555e3d288df09d7b89a9967b07",
preferred=True,
)
version(
"1.14.0",
sha256="a571cc83efda62e1a51a0a912dd916d01895801c5025af91669484a1575a6ef4",
preferred=True,
)
version(
"1.12.2",
sha256="2a89af03d56ce7502dcae18232c241281ad1773561ec00c0f0e8ee2463910f14",
preferred=True,
)
version(
"1.12.1",
sha256="79c66ff67e666665369396e9c90b32e238e501f345afd2234186bfb8331081ca",
preferred=True,
)
version(
"1.12.0",
sha256="a62dcb276658cb78e6795dd29bf926ed7a9bc4edf6e77025cd2c689a8f97c17a",
preferred=True,
)
version(
"1.10.9",
sha256="f5b77f59b705a755a5a223372d0222c7bc408fe8db6fa8d9d7ecf8bce291b8dd",
preferred=True,
)
version(
"1.10.8",
sha256="d341b80d380dd763753a0ebe22915e11e87aac4e44a084a850646ff934d19c80",
preferred=True,
)
version(
"1.10.7",
sha256="7a1a0a54371275ce2dfc5cd093775bb025c365846512961e7e5ceaecb437ef15",
preferred=True,
)
version(
"1.10.6",
sha256="5f9a3ee85db4ea1d3b1fa9159352aebc2af72732fc2f58c96a3f0768dba0e9aa",
preferred=True,
)
version(
"1.10.5",
sha256="6d4ce8bf902a97b050f6f491f4268634e252a63dadd6656a1a9be5b7b7726fa8",
preferred=True,
)
version(
"1.10.4",
sha256="8f60dc4dd6ab5fcd23c750d1dc5bca3d0453bdce5c8cdaf0a4a61a9d1122adb2",
preferred=True,
)
version(
"1.10.3",
sha256="b600d7c914cfa80ae127cd1a1539981213fee9994ac22ebec9e3845e951d9b39",
preferred=True,
)
version(
"1.10.2",
sha256="bfec1be8c366965a99812cf02ddc97e4b708c1754fccba5414d4adccdc073866",
preferred=True,
)
version(
"1.10.1",
sha256="048a9d149fb99aaa1680a712963f5a78e9c43b588d0e79d55e06760ec377c172",
preferred=True,
)
version(
"1.10.0-patch1",
sha256="6e78cfe32a10e6e0629393cdfddf6cfa536571efdaf85f08e35326e1b4e9eff0",
preferred=True,
)
version(
"1.10.0",
sha256="81f6201aba5c30dced5dcd62f5d5477a2790fd5850e02ac514ca8bf3e2bb375a",
preferred=True,
)
version(
"1.8.22",
sha256="8406d96d9355ef8961d2739fb8fd5474ad4cdf52f3cfac657733defd9709bfaa",
preferred=True,
)
version(
"1.8.21",
sha256="87d8c82eba5cf766d97cd06c054f4639c1049c4adeaa3a79f77f8bd374f80f37",
preferred=True,
)
version(
"1.8.19",
sha256="a4335849f19fae88c264fd0df046bc321a78c536b2548fc508627a790564dc38",
preferred=True,
)
version(
"1.8.18",
sha256="cdb195ad8d9e6782acf24b2488061289f615628c2ccda8457b0a0c3fb7a8a063",
preferred=True,
)
version(
"1.8.17",
sha256="d9cda297ee76ade9881c4208987939250d397bae6252d0ccb66fa7d24d67e263",
preferred=True,
)
version(
"1.8.16",
sha256="ed17178abd9928a7237f30370189ba767b9e39e0db45917c2ac4665eb9cb4771",
preferred=True,
)
version(
"1.8.15",
sha256="4e963216b7d32469596bc1321a8c3f6e0c278dcbbdb7be6414c63c081b34c275",
preferred=True,
)
version(
"1.8.14",
sha256="1dbefeeef7f591897c632b2b090db96bb8d35ad035beaa36bc39cb2bc67e0639",
preferred=True,
)
version(
"1.8.13",
sha256="82f6b38eec103b4fccfbf14892786e0c27a8135d3252d8601cf5bf20066d38c1",
preferred=True,
)
version(
"1.8.12",
sha256="b5cccea850096962b5fd9e96f22c4f47d2379224bb41130d9bc038bb6c37dfcb",
preferred=True,
)
version(
"1.8.10",
sha256="4813b79c5fb8701a625b9924b8203bc7154a77f9b826ad4e034144b4056a160a",
preferred=True,
)
variant("shared", default=True, description="Builds a shared version of the library")
variant("hl", default=False, description="Enable the high-level library")
variant("cxx", default=False, description="Enable C++ support")
variant("map", when="@1.14:", default=False, description="Enable MAP API support")
variant("fortran", default=False, description="Enable Fortran support")
variant("java", when="@1.10:", default=False, description="Enable Java support")
variant("threadsafe", default=False, description="Enable thread-safe capabilities")
variant("tools", default=True, description="Enable building tools")
variant("mpi", default=True, description="Enable MPI support")
variant("szip", default=False, description="Enable szip support")
# Build HDF5 with API compatibility.
variant(
"api",
default="default",
description="Choose api compatibility for earlier version",
values=("default", "v116", "v114", "v112", "v110", "v18", "v16"),
multi=False,
)
depends_on("cmake@3.12:", type="build")
depends_on("cmake@3.18:", type="build", when="@1.13:")
depends_on("mpi", when="+mpi")
depends_on("java", type=("build", "run"), when="+java")
depends_on("szip", when="+szip")
depends_on("zlib@1.1.2:")
# The compiler wrappers (h5cc, h5fc, etc.) run 'pkg-config'.
# Skip this on Windows since pkgconfig is autotools
for plat in ["cray", "darwin", "linux"]:
depends_on("pkgconfig", when=f"platform={plat}", type="run")
conflicts("+mpi", "^mpich@4.0:4.0.3")
conflicts("api=v116", when="@1.6:1.14", msg="v116 is not compatible with this release")
conflicts(
"api=v116",
when="@develop-1.8:develop-1.14",
msg="v116 is not compatible with this release",
)
conflicts("api=v114", when="@1.6:1.12", msg="v114 is not compatible with this release")
conflicts(
"api=v114",
when="@develop-1.8:develop-1.12",
msg="v114 is not compatible with this release",
)
conflicts("api=v112", when="@1.6:1.10", msg="v112 is not compatible with this release")
conflicts(
"api=v112",
when="@develop-1.8:develop-1.10",
msg="v112 is not compatible with this release",
)
conflicts("api=v110", when="@1.6:1.8", msg="v110 is not compatible with this release")
conflicts("api=v110", when="@develop-1.8", msg="v110 is not compatible with this release")
conflicts("api=v18", when="@1.6", msg="v18 is not compatible with this release")
# The Java wrappers cannot be built without shared libs.
conflicts("+java", when="~shared")
# Fortran fails built with shared for old HDF5 versions
conflicts("+fortran", when="+shared@:1.8.15")
# See https://github.com/spack/spack/issues/31085
conflicts("+fortran+mpi", when="@1.8.22")
# See https://github.com/HDFGroup/hdf5/issues/2906#issue-1697749645
conflicts(
"+fortran", when="@1.13.3:^cmake@:3.22", msg="cmake_minimum_required is not set correctly."
)
# There are several officially unsupported combinations of the features:
# 1. Thread safety is not guaranteed via high-level C-API but in some cases
# it works.
# conflicts('+threadsafe+hl')
# 2. Thread safety is not guaranteed via Fortran (CXX) API, but it's
# possible for a dependency tree to contain a package that uses Fortran
# (CXX) API in a single thread and another one that uses low-level C-API
# in multiple threads. To allow for such scenarios, we don't specify the
# following conflicts.
# conflicts('+threadsafe+cxx')
# conflicts('+threadsafe+fortran')
# 3. Parallel features are not supported via CXX API, but for the reasons
# described in #2 we allow for such combination.
# conflicts('+mpi+cxx')
# There are known build failures with intel@18.0.1. This issue is
# discussed and patch is provided at
# https://software.intel.com/en-us/forums/intel-fortran-compiler-for-linux-and-mac-os-x/topic/747951.
patch("h5f90global-mult-obj-same-equivalence-same-common-block.patch", when="@1.10.1%intel@18")
# Turn line comments into block comments to conform with pre-C99 language
# standards. Versions of hdf5 after 1.8.10 don't require this patch,
# either because they conform to pre-C99 or neglect to ask for pre-C99
# language standards from their compiler. The hdf5 build system adds
# the -ansi cflag (run 'man gcc' for info on -ansi) for some versions
# of some compilers (see hdf5-1.8.10/config/gnu-flags). The hdf5 build
# system does not provide an option to disable -ansi, but since the
# pre-C99 code is restricted to just five lines of line comments in
# three src files, this patch accomplishes the simple task of patching the
# three src files and leaves the hdf5 build system alone.
patch("pre-c99-comments.patch", when="@1.8.10")
# There are build errors with GCC 8, see
# https://forum.hdfgroup.org/t/1-10-2-h5detect-compile-error-gcc-8-1-0-on-centos-7-2-solved/4441
patch(
"https://salsa.debian.org/debian-gis-team/hdf5/raw/bf94804af5f80f662cad80a5527535b3c6537df6/debian/patches/gcc-8.patch",
sha256="57cee5ff1992b4098eda079815c36fc2da9b10e00a9056df054f2384c4fc7523",
when="@1.10.2%gcc@8:",
)
# Disable MPI C++ interface when C++ is disabled, otherwise downstream
# libraries fail to link; see https://github.com/spack/spack/issues/12586
patch(
"h5public-skip-mpicxx.patch",
when="@1.8.10:1.8.21,1.10.0:1.10.5+mpi~cxx",
sha256="b61e2f058964ad85be6ee5ecea10080bf79e73f83ff88d1fa4b602d00209da9c",
)
# Fixes BOZ literal constant error when compiled with GCC 10.
# The issue is described here: https://github.com/spack/spack/issues/18625
patch(
"hdf5_1.8_gcc10.patch",
when="@:1.8.21",
sha256="0e20187cda3980a4fdff410da92358b63de7ebef2df1d7a425371af78e50f666",
)
patch("fortran-kinds.patch", when="@1.10.7")
# This patch may only be needed with GCC11.2 on macOS, but it's valid for
# any of the head HDF5 versions as of 12/2021. Since it's impossible to
# tell what Fortran version is part of a mixed apple-clang toolchain on
# macOS (which is the norm), and this might be an issue for other compilers
# as well, we just apply it to all platforms.
# See https://github.com/HDFGroup/hdf5/issues/1157
patch("fortran-kinds-2.patch", when="@1.10.8,1.12.1")
# Patch needed for HDF5 1.14.0 where dependency on MPI::MPI_C was declared
# PUBLIC. Dependent packages using the default hdf5 package but not
# expecting to use MPI then failed to configure because they did not call
# find_package(MPI). This patch does that for them. Later HDF5 versions
# will include the patch code changes.
patch("hdf5_1_14_0_config_find_mpi.patch", when="@1.14.0")
# The argument 'buf_size' of the C function 'h5fget_file_image_c' is
# declared as intent(in) though it is modified by the invocation. As a
# result, aggressive compilers such as Fujitsu's may do a wrong
# optimization to cause an error.
def patch(self):
filter_file(
"INTEGER(SIZE_T), INTENT(IN) :: buf_size",
"INTEGER(SIZE_T), INTENT(OUT) :: buf_size",
"fortran/src/H5Fff.F90",
string=True,
ignore_absent=True,
)
filter_file(
"INTEGER(SIZE_T), INTENT(IN) :: buf_size",
"INTEGER(SIZE_T), INTENT(OUT) :: buf_size",
"fortran/src/H5Fff_F03.f90",
string=True,
ignore_absent=True,
)
if self.run_tests:
# hdf5 has ~2200 CPU-intensive tests, some of them have races:
# Often, these loop endless(at least on one Xeon and one EPYC).
# testphdf5 fails indeterministic. This fixes finishing the tests
filter_file(
"REMOVE_ITEM H5P_TESTS",
"REMOVE_ITEM H5P_TESTS t_bigio t_shapesame testphdf5",
"testpar/CMakeTests.cmake",
)
# The parallel compiler wrappers (i.e. h5pcc, h5pfc, etc.) reference MPI
# compiler wrappers and do not need to be changed.
# These do not exist on Windows.
# Enable only for supported target platforms.
for spack_spec_target_platform in ["linux", "darwin", "cray"]:
filter_compiler_wrappers(
"h5cc",
"h5hlcc",
"h5fc",
"h5hlfc",
"h5c++",
"h5hlc++",
relative_root="bin",
when=f"platform={spack_spec_target_platform}",
)
def url_for_version(self, version):
url = (
"https://support.hdfgroup.org/ftp/HDF5/releases/hdf5-{0}/hdf5-{1}/src/hdf5-{1}.tar.gz"
)
return url.format(version.up_to(2), version)
def flag_handler(self, name, flags):
spec = self.spec
cmake_flags = []
if name == "cflags":
if spec.compiler.name in ["gcc", "clang", "apple-clang", "oneapi"]:
# Quiet warnings/errors about implicit declaration of functions
# in C99:
cmake_flags.append("-Wno-error=implicit-function-declaration")
# Note that this flag will cause an error if building %nvhpc.
if spec.satisfies("@:1.8.12~shared"):
# More recent versions set CMAKE_POSITION_INDEPENDENT_CODE to
# True and build with PIC flags.
cmake_flags.append(self.compiler.cc_pic_flag)
if spec.satisfies("@1.8.21 %oneapi@2023.0.0"):
cmake_flags.append("-Wno-error=int-conversion")
elif name == "cxxflags":
if spec.satisfies("@:1.8.12+cxx~shared"):
cmake_flags.append(self.compiler.cxx_pic_flag)
elif name == "fflags":
if spec.satisfies("%cce+fortran"):
# Cray compiler generates module files with uppercase names by
# default, which is not handled by the CMake scripts. The
# following flag forces the compiler to produce module files
# with lowercase names.
cmake_flags.append("-ef")
if spec.satisfies("@:1.8.12+fortran~shared"):
cmake_flags.append(self.compiler.fc_pic_flag)
elif name == "ldlibs":
if "+fortran %fj" in spec:
cmake_flags.extend(["-lfj90i", "-lfj90f", "-lfjsrcinfo", "-lelf"])
return flags, None, (cmake_flags or None)
@property
def libs(self):
"""HDF5 can be queried for the following parameters:
- "hl": high-level interface
- "cxx": C++ APIs
- "fortran": Fortran APIs
- "java": Java APIs
:return: list of matching libraries
"""
query_parameters = self.spec.last_query.extra_parameters
shared = "+shared" in self.spec
# This map contains a translation from query_parameters
# to the libraries needed
query2libraries = {
tuple(): ["libhdf5"],
("cxx", "fortran", "hl", "java"): [
# When installed with Autotools, the basename of the real
# library file implementing the High-level Fortran interface is
# 'libhdf5hl_fortran'. Starting versions 1.8.22, 1.10.5 and
# 1.12.0, the Autotools installation also produces a symbolic
# link 'libhdf5_hl_fortran.<so/a>' to
# 'libhdf5hl_fortran.<so/a>'. Note that in the case of the
# dynamic library, the latter is a symlink to the real sonamed
# file 'libhdf5_fortran.so.<abi-version>'. This means that all
# dynamically linked executables/libraries of the dependent
# packages need 'libhdf5_fortran.so.<abi-version>' with the same
# DT_SONAME entry. However, the CMake installation (at least
# starting version 1.8.10) does not produce it. Instead, the
# basename of the library file is 'libhdf5_hl_fortran'. Which
# means that switching to CMake requires rebuilding of all
# dependant packages that use the High-level Fortran interface.
# Therefore, we do not try to preserve backward compatibility
# with Autotools installations by creating symlinks. The only
# packages that could benefit from it would be those that
# hardcode the library name in their building systems. Such
# packages should simply be patched.
"libhdf5_hl_fortran",
"libhdf5_hl_f90cstub",
"libhdf5_hl_cpp",
"libhdf5_hl",
"libhdf5_fortran",
"libhdf5_f90cstub",
"libhdf5_java",
"libhdf5",
],
("cxx", "hl"): ["libhdf5_hl_cpp", "libhdf5_hl", "libhdf5"],
("fortran", "hl"): [
"libhdf5_hl_fortran",
"libhdf5_hl_f90cstub",
"libhdf5_hl",
"libhdf5_fortran",
"libhdf5_f90cstub",
"libhdf5",
],
("hl",): ["libhdf5_hl", "libhdf5"],
("cxx", "fortran"): ["libhdf5_fortran", "libhdf5_f90cstub", "libhdf5_cpp", "libhdf5"],
("cxx",): ["libhdf5_cpp", "libhdf5"],
("fortran",): ["libhdf5_fortran", "libhdf5_f90cstub", "libhdf5"],
("java",): ["libhdf5_java", "libhdf5"],
}
# Turn the query into the appropriate key
key = tuple(sorted(query_parameters))
libraries = query2libraries[key]
return find_libraries(libraries, root=self.prefix, shared=shared, recursive=True)
@classmethod
def determine_version(cls, exe):
output = Executable(exe)("-showconfig", output=str, error=str)
match = re.search(r"HDF5 Version: (\d+\.\d+\.\d+)(\D*\S*)", output)
return match.group(1) if match else None
@classmethod
def determine_variants(cls, exes, version):
def is_enabled(text):
if text in set(["t", "true", "enabled", "yes", "1"]):
return True
return False
results = []
for exe in exes:
variants = []
output = Executable(exe)("-showconfig", output=str, error=os.devnull)
match = re.search(r"High-level library: (\S+)", output)
if match and is_enabled(match.group(1)):
variants.append("+hl")
else:
variants.append("~hl")
match = re.search(r"Parallel HDF5: (\S+)", output)
if match and is_enabled(match.group(1)):
variants.append("+mpi")
else:
variants.append("~mpi")
match = re.search(r"C\+\+: (\S+)", output)
if match and is_enabled(match.group(1)):
variants.append("+cxx")
else:
variants.append("~cxx")
match = re.search(r"Fortran: (\S+)", output)
if match and is_enabled(match.group(1)):
variants.append("+fortran")
else:
variants.append("~fortran")
match = re.search(r"Java: (\S+)", output)
if match and is_enabled(match.group(1)):
variants.append("+java")
else:
variants.append("~java")
match = re.search(r"Threadsafety: (\S+)", output)
if match and is_enabled(match.group(1)):
variants.append("+threadsafe")
else:
variants.append("~threadsafe")
match = re.search(r"Build HDF5 Tools: (\S+)", output)
if match and is_enabled(match.group(1)):
variants.append("+tools")
else:
variants.append("~tools")
match = re.search(r"I/O filters \(external\): \S*(szip\(encoder\))\S*", output)
if match:
variants.append("+szip")
else:
variants.append("~szip")
match = re.search(r"Default API mapping: (\S+)", output)
if match and match.group(1) in set(["v114", "v112", "v110", "v18", "v16"]):
variants.append("api={0}".format(match.group(1)))
results.append(" ".join(variants))
return results
@when("@:1.8.21,1.10.0:1.10.5+szip")
def setup_build_environment(self, env):
env.set("SZIP_INSTALL", self.spec["szip"].prefix)
@run_before("cmake")
def fortran_check(self):
if "+fortran" in self.spec and not self.compiler.fc:
msg = "cannot build a Fortran variant without a Fortran compiler"
raise RuntimeError(msg)
def cmake_args(self):
spec = self.spec
if spec.satisfies("@:1.8.15+shared"):
tty.warn("hdf5@:1.8.15+shared does not produce static libraries")
args = [
# Always enable this option. This does not actually enable any
# features: it only *allows* the user to specify certain
# combinations of other arguments.
self.define("ALLOW_UNSUPPORTED", True),
# Speed-up the building by skipping the examples:
self.define("HDF5_BUILD_EXAMPLES", False),
self.define(
"BUILD_TESTING",
self.run_tests or
# Version 1.8.22 fails to build the tools when shared libraries
# are enabled but the tests are disabled.
spec.satisfies("@1.8.22+shared+tools"),
),
self.define_from_variant("HDF5_ENABLE_MAP_API", "map"),
self.define("HDF5_ENABLE_Z_LIB_SUPPORT", True),
self.define_from_variant("HDF5_ENABLE_SZIP_SUPPORT", "szip"),
self.define_from_variant("HDF5_ENABLE_SZIP_ENCODING", "szip"),
self.define_from_variant("BUILD_SHARED_LIBS", "shared"),
self.define("ONLY_SHARED_LIBS", False),
self.define_from_variant("HDF5_ENABLE_PARALLEL", "mpi"),
self.define_from_variant("HDF5_ENABLE_THREADSAFE", "threadsafe"),
self.define_from_variant("HDF5_BUILD_HL_LIB", "hl"),
self.define_from_variant("HDF5_BUILD_CPP_LIB", "cxx"),
self.define_from_variant("HDF5_BUILD_FORTRAN", "fortran"),
self.define_from_variant("HDF5_BUILD_JAVA", "java"),
self.define_from_variant("HDF5_BUILD_TOOLS", "tools"),
]
api = spec.variants["api"].value
if api != "default":
args.append(self.define("DEFAULT_API_VERSION", api))
# MSMPI does not provide compiler wrappers
# and pointing these variables at the MSVC compilers
# breaks CMake's mpi detection for MSMPI.
if "+mpi" in spec and "msmpi" not in spec:
args.extend(
[
"-DMPI_CXX_COMPILER:PATH=%s" % spec["mpi"].mpicxx,
"-DMPI_C_COMPILER:PATH=%s" % spec["mpi"].mpicc,
]
)
if "+fortran" in spec:
args.extend(["-DMPI_Fortran_COMPILER:PATH=%s" % spec["mpi"].mpifc])
# work-around for https://github.com/HDFGroup/hdf5/issues/1320
if spec.satisfies("@1.10.8,1.13.0"):
args.append(self.define("HDF5_INSTALL_CMAKE_DIR", "share/cmake/hdf5"))
return args
@run_after("install")
def ensure_parallel_compiler_wrappers(self):
# When installed with Autotools and starting at least version 1.8.10,
# the package produces C compiler wrapper called either 'h5cc' (when MPI
# support is disabled) or 'h5pcc' (when MPI support is enabled). The
# CMake installation produces the wrapper called 'h5cc' (regardless of
# whether MPI support is enabled) only starting versions 1.8.21, 1.10.2
# and 1.12.0. The current develop versions also produce 'h5pcc' when MPI
# support is enabled and the file is identical to 'h5cc'. Here, we make
# sure that 'h5pcc' is available when MPI support is enabled (only for
# versions that generate 'h5cc').
if self.spec.satisfies("@1.8.21:1.8.22,1.10.2:1.10.7,1.12.0+mpi"):
with working_dir(self.prefix.bin):
# No try/except here, fix the condition above instead:
symlink("h5cc", "h5pcc")
# The same as for 'h5pcc'. However, the CMake installation produces the
# Fortran compiler wrapper called 'h5fc' only starting versions 1.8.22,
# 1.10.6 and 1.12.0. The current develop versions do not produce 'h5pfc'
# at all. Here, we make sure that 'h5pfc' is available when Fortran and
# MPI support are enabled (only for versions that generate 'h5fc').
if self.spec.satisfies("@1.8.22:1.8," "1.10.6:1.10," "1.12.0:1.12" "+fortran+mpi"):
with working_dir(self.prefix.bin):
# No try/except here, fix the condition above instead:
symlink("h5fc", "h5pfc")
@run_after("install")
def fix_package_config(self):
# We need to fix the pkg-config files, which are also used by the
# compiler wrappers. The files are created starting versions 1.8.21,
# 1.10.2 and 1.12.0. However, they are broken (except for the version
# 1.8.22): the files are named <name>-<version>.pc but reference <name>
# packages. This was fixed in the develop versions at some point: the
# files started referencing <name>-<version> packages but got broken
# again: the files got names <name>.pc but references had not been
# updated accordingly. Another issue, which we address here, is that
# some Linux distributions install pkg-config files named hdf5.pc and we
# want to override them. Therefore, the following solution makes sure
# that each <name>-<version>.pc file is symlinked by <name>.pc and all
# references to <name>-<version> packages in the original files are
# replaced with references to <name> packages.
pc_files = find(self.prefix.lib.pkgconfig, "hdf5*.pc", recursive=False)
if not pc_files:
# This also tells us that the pkgconfig directory does not exist.
return
# Replace versioned references in all pkg-config files:
filter_file(
r"(Requires(?:\.private)?:.*)(hdf5[^\s,]*)(?:-[^\s,]*)(.*)",
r"\1\2\3",
*pc_files,
backup=False,
)
# Create non-versioned symlinks to the versioned pkg-config files:
with working_dir(self.prefix.lib.pkgconfig):
for f in pc_files:
src_filename = os.path.basename(f)
version_sep_idx = src_filename.find("-")
if version_sep_idx > -1:
tgt_filename = src_filename[:version_sep_idx] + ".pc"
if not os.path.exists(tgt_filename):
symlink(src_filename, tgt_filename)
@run_after("install")
def fix_showconfig(self):
# The 'Extra libraries' entry of the 'h5cc -showconfig' command is a space-separated list
# of linker flags if the package is installed with Autotools, and a semicolon-separated
# list of library names if the package is installed with CMake. There are use cases that
# rely on the old Autotools behavior. Here, we make sure that the output of the command
# looks like it was before we switch to CMake.
filter_file(
r"^(\s*Extra libraries: )(.*)",
lambda match: "{0}{1}".format(
match.group(1),
" ".join("-l{0}".format(name) for name in filter(None, match.group(2).split(";"))),
),
self.prefix.lib.join("libhdf5.settings"),
backup=False,
ignore_absent=True,
)
@run_after("install")
@on_package_attributes(run_tests=True)
def check_install(self):
self._check_install()
def _check_install(self):
# Build and run a small program to test the installed HDF5 library
spec = self.spec
print("Checking HDF5 installation...")
checkdir = "spack-check"
with working_dir(checkdir, create=True):
# Because the release number in a develop branch is not fixed,
# only the major and minor version numbers are compared.
# Otherwise all 3 numbers are checked.
if "develop" in str(spec.version.up_to(3)):
source = r"""
#include <hdf5.h>
#include <assert.h>
#include <stdio.h>
int main(int argc, char **argv) {
unsigned majnum, minnum, relnum;
herr_t herr = H5get_libversion(&majnum, &minnum, &relnum);
assert(!herr);
printf("HDF5 version %d.%d %u.%u\n", H5_VERS_MAJOR, H5_VERS_MINOR,
majnum, minnum);
return 0;
}
"""
else:
source = r"""
#include <hdf5.h>
#include <assert.h>
#include <stdio.h>
int main(int argc, char **argv) {
unsigned majnum, minnum, relnum;
herr_t herr = H5get_libversion(&majnum, &minnum, &relnum);
assert(!herr);
printf("HDF5 version %d.%d.%d %u.%u.%u\n", H5_VERS_MAJOR, H5_VERS_MINOR,
H5_VERS_RELEASE, majnum, minnum, relnum);
return 0;
}
"""
expected = """\
HDF5 version {version} {version}
""".format(
version=str(spec.version.up_to(3))
)
if "develop" in expected:
# Remove 'develop-' from the version in spack for checking
# version against the version in the HDF5 code.
expected = """\
HDF5 version {version} {version}
""".format(
version=str(spec.version.up_to(3)).partition("-")[2]
)
with open("check.c", "w") as f:
f.write(source)
if "+mpi" in spec:
cc = Executable(spec["mpi"].mpicc)
else:
cc = Executable(self.compiler.cc)
cc(*(["-c", "check.c"] + spec["hdf5"].headers.cpp_flags.split()))
cc(*(["-o", "check", "check.o"] + spec["hdf5"].libs.ld_flags.split()))
try:
check = Executable("./check")
output = check(output=str)
except ProcessError:
output = ""
success = output == expected
if not success:
print("Produced output does not match expected output.")
print("Expected output:")
print("-" * 80)
print(expected)
print("-" * 80)
print("Produced output:")
print("-" * 80)
print(output)
print("-" * 80)
raise RuntimeError("HDF5 install check failed")
shutil.rmtree(checkdir)
def _test_check_versions(self):
"""Perform version checks on selected installed package binaries."""
spec_vers_str = "Version {0}".format(self.spec.version)
if "develop" in spec_vers_str:
# Remove 'develop-' from the version in spack for checking
# version against the version in the HDF5 code.
spec_vers_str = spec_vers_str.partition("-")[2]
exes = [
"h5copy",
"h5diff",
"h5dump",
"h5format_convert",
"h5ls",
"h5mkgrp",
"h5repack",
"h5stat",
"h5unjam",
]
use_short_opt = ["h52gif", "h5repart", "h5unjam"]
for exe in exes:
reason = "test: ensuring version of {0} is {1}".format(exe, spec_vers_str)
option = "-V" if exe in use_short_opt else "--version"
self.run_test(
exe, option, spec_vers_str, installed=True, purpose=reason, skip_missing=True
)
def _test_example(self):
"""This test performs copy, dump, and diff on an example hdf5 file."""
test_data_dir = self.test_suite.current_test_data_dir
filename = "spack.h5"
h5_file = test_data_dir.join(filename)
reason = "test: ensuring h5dump produces expected output"
expected = get_escaped_text_output(test_data_dir.join("dump.out"))
self.run_test(
"h5dump",
filename,
expected,
installed=True,
purpose=reason,
skip_missing=True,
work_dir=test_data_dir,
)
reason = "test: ensuring h5copy runs"
options = ["-i", h5_file, "-s", "Spack", "-o", "test.h5", "-d", "Spack"]
self.run_test(
"h5copy", options, [], installed=True, purpose=reason, skip_missing=True, work_dir="."
)
reason = "test: ensuring h5diff shows no differences between orig and" " copy"
self.run_test(
"h5diff",
[h5_file, "test.h5"],
[],
installed=True,
purpose=reason,
skip_missing=True,
work_dir=".",
)
def test(self):
"""Perform smoke tests on the installed package."""
# Simple version check tests on known binaries
self._test_check_versions()
# Run sequence of commands on an hdf5 file
self._test_example()
# Run existing install check
self._check_install()
|