diff options
Diffstat (limited to 'mesonbuild/dependencies/hdf5.py')
| -rw-r--r-- | mesonbuild/dependencies/hdf5.py | 235 |
1 files changed, 131 insertions, 104 deletions
diff --git a/mesonbuild/dependencies/hdf5.py b/mesonbuild/dependencies/hdf5.py index 6280010..10bdb25 100644 --- a/mesonbuild/dependencies/hdf5.py +++ b/mesonbuild/dependencies/hdf5.py @@ -14,122 +14,149 @@ # This file contains the detection logic for miscellaneous external dependencies. +import functools import subprocess import shutil +import re from pathlib import Path -from .. import mlog -from ..mesonlib import split_args, listify -from .base import (DependencyException, DependencyMethods, ExternalDependency, ExternalProgram, - PkgConfigDependency) +from ..mesonlib import OrderedSet +from .base import ( + DependencyException, DependencyMethods, ConfigToolDependency, + PkgConfigDependency, factory_methods +) import typing as T if T.TYPE_CHECKING: + from .base import Dependency + from ..envconfig import MachineChoice from ..environment import Environment -class HDF5Dependency(ExternalDependency): - def __init__(self, environment: 'Environment', kwargs: T.Dict[str, T.Any]) -> None: - language = kwargs.get('language', 'c') - super().__init__('hdf5', environment, kwargs, language=language) - kwargs['required'] = False - kwargs['silent'] = True - self.is_found = False - methods = listify(self.methods) +class HDF5PkgConfigDependency(PkgConfigDependency): - if language not in ('c', 'cpp', 'fortran'): + """Handle brokenness in the HDF5 pkg-config files.""" + + def __init__(self, name: str, environment: 'Environment', kwargs: T.Dict[str, T.Any], language: T.Optional[str] = None) -> None: + language = language or 'c' + if language not in {'c', 'cpp', 'fortran'}: + raise DependencyException('Language {} is not supported with HDF5.'.format(language)) + + super().__init__(name, environment, kwargs, language) + if not self.is_found: + return + + # some broken pkgconfig don't actually list the full path to the needed includes + newinc = [] # type: T.List[str] + for arg in self.compile_args: + if arg.startswith('-I'): + stem = 'static' if kwargs.get('static', False) else 'shared' + if (Path(arg[2:]) / stem).is_dir(): + newinc.append('-I' + str(Path(arg[2:]) / stem)) + self.compile_args += newinc + + link_args = [] # type: T.List[str] + for larg in self.get_link_args(): + lpath = Path(larg) + # some pkg-config hdf5.pc (e.g. Ubuntu) don't include the commonly-used HL HDF5 libraries, + # so let's add them if they exist + # additionally, some pkgconfig HDF5 HL files are malformed so let's be sure to find HL anyway + if lpath.is_file(): + hl = [] + if language == 'cpp': + hl += ['_hl_cpp', '_cpp'] + elif language == 'fortran': + hl += ['_hl_fortran', 'hl_fortran', '_fortran'] + hl += ['_hl'] # C HL library, always needed + + suffix = '.' + lpath.name.split('.', 1)[1] # in case of .dll.a + for h in hl: + hlfn = lpath.parent / (lpath.name.split('.', 1)[0] + h + suffix) + if hlfn.is_file(): + link_args.append(str(hlfn)) + # HDF5 C libs are required by other HDF5 languages + link_args.append(larg) + else: + link_args.append(larg) + + self.link_args = link_args + + +class HDF5ConfigToolDependency(ConfigToolDependency): + + """Wrapper around hdf5 binary config tools.""" + + version_arg = '-showconfig' + + def __init__(self, name: str, environment: 'Environment', kwargs: T.Dict[str, T.Any], language: T.Optional[str] = None) -> None: + language = language or 'c' + if language not in {'c', 'cpp', 'fortran'}: raise DependencyException('Language {} is not supported with HDF5.'.format(language)) - if set([DependencyMethods.AUTO, DependencyMethods.PKGCONFIG]).intersection(methods): - pkgconfig_files = ['hdf5', 'hdf5-serial'] - PCEXE = shutil.which('pkg-config') - if PCEXE: - # some distros put hdf5-1.2.3.pc with version number in .pc filename. - ret = subprocess.run([PCEXE, '--list-all'], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, - universal_newlines=True) - if ret.returncode == 0: - for pkg in ret.stdout.split('\n'): - if pkg.startswith(('hdf5')): - pkgconfig_files.append(pkg.split(' ', 1)[0]) - pkgconfig_files = list(set(pkgconfig_files)) # dedupe - - for pkg in pkgconfig_files: - pkgdep = PkgConfigDependency(pkg, environment, kwargs, language=self.language) - if not pkgdep.found(): - continue - - self.compile_args = pkgdep.get_compile_args() - # some broken pkgconfig don't actually list the full path to the needed includes - newinc = [] - for arg in self.compile_args: - if arg.startswith('-I'): - stem = 'static' if kwargs.get('static', False) else 'shared' - if (Path(arg[2:]) / stem).is_dir(): - newinc.append('-I' + str(Path(arg[2:]) / stem)) - self.compile_args += newinc - - # derive needed libraries by language - pd_link_args = pkgdep.get_link_args() - link_args = [] - for larg in pd_link_args: - lpath = Path(larg) - # some pkg-config hdf5.pc (e.g. Ubuntu) don't include the commonly-used HL HDF5 libraries, - # so let's add them if they exist - # additionally, some pkgconfig HDF5 HL files are malformed so let's be sure to find HL anyway - if lpath.is_file(): - hl = [] - if language == 'cpp': - hl += ['_hl_cpp', '_cpp'] - elif language == 'fortran': - hl += ['_hl_fortran', 'hl_fortran', '_fortran'] - hl += ['_hl'] # C HL library, always needed - - suffix = '.' + lpath.name.split('.', 1)[1] # in case of .dll.a - for h in hl: - hlfn = lpath.parent / (lpath.name.split('.', 1)[0] + h + suffix) - if hlfn.is_file(): - link_args.append(str(hlfn)) - # HDF5 C libs are required by other HDF5 languages - link_args.append(larg) - else: - link_args.append(larg) - - self.link_args = link_args - self.version = pkgdep.get_version() - self.is_found = True - self.pcdep = pkgdep - return - - if DependencyMethods.AUTO in methods: - wrappers = {'c': 'h5cc', 'cpp': 'h5c++', 'fortran': 'h5fc'} - comp_args = [] - link_args = [] - # have to always do C as well as desired language - for lang in set([language, 'c']): - prog = ExternalProgram(wrappers[lang], silent=True) - if not prog.found(): - return - shlib_arg = '-noshlib' if kwargs.get('static', False) else '-shlib' - cmd = prog.get_command() + [shlib_arg, '-show'] - p = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True, timeout=15) - if p.returncode != 0: - mlog.debug('Command', mlog.bold(str(cmd)), 'failed to run:') - mlog.debug(mlog.bold('Standard output\n'), p.stdout) - mlog.debug(mlog.bold('Standard error\n'), p.stderr) - return - args = split_args(p.stdout) - for arg in args[1:]: - if arg.startswith(('-I', '-f', '-D')) or arg == '-pthread': - comp_args.append(arg) - elif arg.startswith(('-L', '-l', '-Wl')): - link_args.append(arg) - elif Path(arg).is_file(): - link_args.append(arg) - self.compile_args = comp_args - self.link_args = link_args - self.is_found = True + if language == 'c': + tools = ['h5cc'] + elif language == 'cpp': + tools = ['h5c++'] + elif language == 'fortran': + tools = ['h5fc'] + else: + raise DependencyException('How did you get here?') + + # We need this before we call super() + for_machine = self.get_for_machine_from_kwargs(kwargs) + + nkwargs = kwargs.copy() + nkwargs['tools'] = tools + + super().__init__(name, environment, nkwargs, language) + if not self.is_found: return - @staticmethod - def get_methods() -> T.List[DependencyMethods]: - return [DependencyMethods.AUTO, DependencyMethods.PKGCONFIG] + args = self.get_config_value(['-show', '-noshlib' if kwargs.get('static', False) else '-shlib'], 'args') + for arg in args[1:]: + if arg.startswith(('-I', '-f', '-D')) or arg == '-pthread': + self.compile_args.append(arg) + elif arg.startswith(('-L', '-l', '-Wl')): + self.link_args.append(arg) + elif Path(arg).is_file(): + self.link_args.append(arg) + + # If the language is not C we need to add C as a subdependency + if language != 'c': + nkwargs = kwargs.copy() + nkwargs['language'] = 'c' + # I'm being too clever for mypy and pylint + self.is_found = self._add_sub_dependency(hdf5_factory(environment, self.for_machine, nkwargs)) # type: ignore # pylint: disable=no-value-for-parameter + + def _sanitize_version(self, ver: str) -> str: + v = re.search(r'\s*HDF5 Version: (\d+\.\d+\.\d+)', ver) + return v.group(1) + + +@factory_methods({DependencyMethods.PKGCONFIG, DependencyMethods.CONFIG_TOOL}) +def hdf5_factory(env: 'Environment', for_machine: 'MachineChoice', + kwargs: T.Dict[str, T.Any], methods: T.List[DependencyMethods]) -> T.List[T.Callable[[], 'Dependency']]: + language = kwargs.get('language') + candidates = [] # type: T.List[T.Callable[[], Dependency]] + + if DependencyMethods.PKGCONFIG in methods: + # Use an ordered set so that these remain the first tried pkg-config files + pkgconfig_files = OrderedSet(['hdf5', 'hdf5-serial']) + # FIXME: This won't honor pkg-config paths, and cross-native files + PCEXE = shutil.which('pkg-config') + if PCEXE: + # some distros put hdf5-1.2.3.pc with version number in .pc filename. + ret = subprocess.run([PCEXE, '--list-all'], stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, + universal_newlines=True) + if ret.returncode == 0: + for pkg in ret.stdout.split('\n'): + if pkg.startswith(('hdf5')): + pkgconfig_files.add(pkg.split(' ', 1)[0]) + + for pkg in pkgconfig_files: + candidates.append(functools.partial(HDF5PkgConfigDependency, pkg, env, kwargs, language)) + + if DependencyMethods.CONFIG_TOOL in methods: + candidates.append(functools.partial(HDF5ConfigToolDependency, 'hdf5', env, kwargs, language)) + + return candidates |