add option --search-path-linker to control how linker options at build time

Author: lexming

easybuild/tools/config.py

@@ -262,6 +262,7 @@ def mk_full_default_path(name, prefix=DEFAULT_PREFIX):
         'rpath_override_dirs',
         'required_linked_shared_libs',
         'search_path_cpp_headers',
+        'search_path_linker',
         'skip',
         'software_commit',
         'stop',

easybuild/tools/options.py

@@ -101,8 +101,8 @@
 from easybuild.tools.run import run_shell_cmd
 from easybuild.tools.package.utilities import avail_package_naming_schemes
 from easybuild.tools.toolchain.compiler import DEFAULT_OPT_LEVEL, OPTARCH_MAP_CHAR, OPTARCH_SEP, Compiler
-from easybuild.tools.toolchain.toolchain import SEARCH_PATH_CPP_HEADERS, DEFAULT_SEARCH_PATH_CPP_HEADERS
-from easybuild.tools.toolchain.toolchain import SYSTEM_TOOLCHAIN_NAME
+from easybuild.tools.toolchain.toolchain import DEFAULT_SEARCH_PATH_CPP_HEADERS, DEFAULT_SEARCH_PATH_LINKER
+from easybuild.tools.toolchain.toolchain import SEARCH_PATH_CPP_HEADERS, SEARCH_PATH_LINKER, SYSTEM_TOOLCHAIN_NAME
 from easybuild.tools.repository.repository import avail_repositories
 from easybuild.tools.systemtools import DARWIN, UNKNOWN, check_python_version, get_cpu_architecture, get_cpu_family
 from easybuild.tools.systemtools import get_cpu_features, get_gpu_info, get_os_type, get_system_info
@@ -626,6 +626,8 @@ def config_options(self):
                                'strlist', 'store', self.default_repositorypath),
             'search-path-cpp-headers': ("Search path used at build time for include directories", 'choice',
                                         'store', DEFAULT_SEARCH_PATH_CPP_HEADERS, [*SEARCH_PATH_CPP_HEADERS]),
+            'search-path-linker': ("Search path used at build time by the linker for libraries", 'choice',
+                                   'store', DEFAULT_SEARCH_PATH_LINKER, [*SEARCH_PATH_LINKER]),
             'sourcepath': ("Path(s) to where sources should be downloaded (string, colon-separated)",
                            None, 'store', mk_full_default_path('sourcepath')),
             'subdir-modules': ("Installpath subdir for modules", None, 'store', DEFAULT_PATH_SUBDIRS['subdir_modules']),

easybuild/tools/toolchain/compiler.py

@@ -94,6 +94,7 @@ class Compiler(Toolchain):
         'packed-linker-options': (False, "Pack the linker options as comma separated list"),  # ScaLAPACK mainly
         'rpath': (True, "Use RPATH wrappers when --rpath is enabled in EasyBuild configuration"),
         'search-path-cpp-headers': (None, "Search path used at build time for include directories"),
+        'search-path-linker': (None, "Search path used at build time by the linker for libraries"),
         'extra_cflags': (None, "Specify extra CFLAGS options."),
         'extra_cxxflags': (None, "Specify extra CXXFLAGS options."),
         'extra_fflags': (None, "Specify extra FFLAGS options."),

easybuild/tools/toolchain/constants.py

@@ -58,11 +58,11 @@
         ('PRECFLAGS', 'FP precision flags'),
     ] + COMPILER_FLAGS,
     LibraryList: [
-        ('LIBS', 'Libraries'),  # TODO: where are these used? ld?
-        ('FLIBS', 'Fortran libraries'),  # TODO: where are these used? gfortran only?
+        ('LIBS', 'Libraries'),  # -l options to pass to the linker (C/C++/Fortran)
+        ('FLIBS', 'Fortran libraries'),  # linker flags (e.g. -L and -l) for Fortran libraries
     ],
     LinkLibraryPaths: [
-        ('LDFLAGS', 'Flags passed to linker'),  # TODO: overridden by command line?
+        ('LDFLAGS', 'Linker flags'),
     ],
     IncludePaths: [
         ('CPPFLAGS', 'Preprocessor flags'),
@@ -72,6 +72,7 @@
         ('C_INCLUDE_PATH', 'Location of C header files'),
         ('CPLUS_INCLUDE_PATH', 'Location of C++ header files'),
         ('OBJC_INCLUDE_PATH', 'Location of Objective C header files'),
+        ('LIBRARY_PATH', 'Location of linker files'),
     ],
     CommandFlagList: COMPILER_VARIABLES,
 }

easybuild/tools/toolchain/toolchain.py

@@ -97,6 +97,7 @@
 ]
 # modes to handle CPP header search paths
 # see: https://gcc.gnu.org/onlinedocs/cpp/Environment-Variables.html
+# supported on Linux by: GCC, GFortran, oneAPI C/C++ Compilers, oneAPI Fortran Compiler
 SEARCH_PATH_CPP_HEADERS_FLAGS = "CPPFLAGS"
 SEARCH_PATH_CPP_HEADERS_CPATH = "CPATH"
 SEARCH_PATH_CPP_HEADERS_INCLUDE = "INCLUDE_PATHS"
@@ -107,6 +108,16 @@
 }
 DEFAULT_SEARCH_PATH_CPP_HEADERS = SEARCH_PATH_CPP_HEADERS_FLAGS
 
+# modes to handle linker search paths
+# see: https://gcc.gnu.org/onlinedocs/cpp/Environment-Variables.html
+# supported on Linux by: GCC, GFortran, oneAPI C/C++ Compilers, oneAPI Fortran Compiler
+SEARCH_PATH_LINKER_FLAGS = "LDFLAGS"
+SEARCH_PATH_LINKER_LIBPATH = "LIBRARY_PATH"
+SEARCH_PATH_LINKER = {
+    SEARCH_PATH_LINKER_FLAGS: ["LDFLAGS"],
+    SEARCH_PATH_LINKER_LIBPATH: ["LIBRARY_PATH"],
+}
+DEFAULT_SEARCH_PATH_LINKER = SEARCH_PATH_LINKER_FLAGS
 
 def is_system_toolchain(tc_name):
     """Return whether toolchain with specified name is a system toolchain or not."""
@@ -1122,9 +1133,26 @@ def _add_dependency_linker_paths(self, dep_root, extra_dirs=None):
         lib_dirs = ["lib64", "lib"]
         lib_dirs = unique_ordered_extend(lib_dirs, extra_dirs)
 
-        env_var = "LDFLAGS"
-        self.log.debug("Adding lib paths to toolchain variable '%s': %s", env_var, dep_root)
-        self.variables.append_subdirs(env_var, dep_root, subdirs=lib_dirs)
+        # mode of operation is defined by search-path-linker option
+        # toolchain option has precedence over build option
+        linker_mode = DEFAULT_SEARCH_PATH_LINKER
+        build_opt = build_option("search_path_linker")
+        if self.options.get("search-path-linker") is not None:
+            linker_mode = self.options.option("search-path-linker")
+            self.log.debug("search-path-linker set by toolchain option: %s", linker_mode)
+        elif build_opt is not None:
+            linker_mode = build_opt
+            self.log.debug("search-path-linker set by build option: %s", linker_mode)
+
+        if linker_mode not in SEARCH_PATH_LINKER:
+            raise EasyBuildError(
+                "Unknown value selected for option search-path-linker: %s. Choose one of: %s",
+                linker_mode, ", ".join(SEARCH_PATH_LINKER)
+            )
+
+        for env_var in SEARCH_PATH_LINKER[linker_mode]:
+            self.log.debug("Adding lib paths to toolchain variable '%s': %s", env_var, dep_root)
+            self.variables.append_subdirs(env_var, dep_root, subdirs=lib_dirs)
 
     def _setenv_variables(self, donotset=None, verbose=True):
         """Actually set the environment variables"""