avoid parsing search-path toolchain options more than once

Author: lexming

easybuild/tools/options.py

@@ -101,8 +101,7 @@
 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 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.toolchain.toolchain import DEFAULT_SEARCH_PATH_CPP_HEADERS, DEFAULT_SEARCH_PATH_LINKER, SEARCH_PATH
 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
@@ -625,9 +624,9 @@ def config_options(self):
                                 "For more info, use --avail-repositories."),
                                '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]),
+                                        '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]),
+                                   '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/toolchain.py

@@ -98,17 +98,19 @@
 # modes to handle header and 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, LLVM-based
-SEARCH_PATH_CPP_HEADERS = {
-    "FLAGS": ["CPPFLAGS"],
-    "CPATH": ["CPATH"],
-    "INCLUDE_PATHS": ["C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH", "OBJC_INCLUDE_PATH"],
+SEARCH_PATH = {
+    "cpp_headers" : {
+        "flags": ["CPPFLAGS"],
+        "cpath": ["CPATH"],
+        "include_paths": ["C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH", "OBJC_INCLUDE_PATH"],
+    },
+    "linker" : {
+        "flags": ["LDFLAGS"],
+        "library_path": ["LIBRARY_PATH"],
+    },
 }
-SEARCH_PATH_LINKER = {
-    "FLAGS": ["LDFLAGS"],
-    "LIBRARY_PATH": ["LIBRARY_PATH"],
-}
-DEFAULT_SEARCH_PATH_CPP_HEADERS = "FLAGS"
-DEFAULT_SEARCH_PATH_LINKER = "FLAGS"
+DEFAULT_SEARCH_PATH_CPP_HEADERS = "flags"
+DEFAULT_SEARCH_PATH_LINKER = "flags"
 
 
 def is_system_toolchain(tc_name):
@@ -228,6 +230,11 @@ def __init__(self, name=None, version=None, mns=None, class_constants=None, tcde
 
         self.use_rpath = False
 
+        self.search_path = {
+            "cpp_headers": DEFAULT_SEARCH_PATH_CPP_HEADERS,
+            "linker": DEFAULT_SEARCH_PATH_LINKER,
+        }
+
         self.mns = mns
         self.mod_full_name = None
         self.mod_short_name = None
@@ -375,14 +382,31 @@ def get_variable(self, name, typ=str):
         return res
 
     def set_variables(self):
-        """Do nothing? Everything should have been set by others
-            Needs to be defined for super() relations
-        """
+        """Set generic toolchain variables. Child toolchains oversubscribe this method."""
+
         if self.options.option('packed-linker-options'):
             self.log.devel("set_variables: toolchain variables. packed-linker-options.")
             self.variables.try_function_on_element('set_packed_linker_options')
         self.log.devel("set_variables: toolchain variables. Do nothing.")
 
+        # mode of operation for search paths
+        # toolchain option has precedence over build option
+        for search_path in self.search_path:
+            sp_build_opt = f"search_path_{search_path}"
+            sp_toolchain_opt = sp_build_opt.replace("_", "-")
+            if self.options.get(sp_toolchain_opt) is not None:
+                self.search_path[search_path] = self.options.option(sp_toolchain_opt)
+            elif build_option(sp_build_opt) is not None:
+                self.search_path[search_path] = build_option(sp_build_opt)
+
+            if self.search_path[search_path] not in SEARCH_PATH[search_path]:
+                raise EasyBuildError(
+                    "Unknown value selected for toolchain option %s: %s. Choose one of: %s",
+                    sp_toolchain_opt, self.search_path[search_path], ", ".join(SEARCH_PATH[search_path])
+                )
+
+            self.log.debug("%s toolchain option set to: %s", sp_toolchain_opt, self.search_path[search_path])
+
     def generate_vars(self):
         """Convert the variables in simple vars"""
         self.vars = {}
@@ -1094,24 +1118,7 @@ def _add_dependency_cpp_headers(self, dep_root, extra_dirs=None):
         header_dirs = ["include"]
         header_dirs = unique_ordered_extend(header_dirs, extra_dirs)
 
-        # mode of operation is defined by search-path-cpp-headers option
-        # toolchain option has precedence over build option
-        cpp_headers_mode = DEFAULT_SEARCH_PATH_CPP_HEADERS
-        build_opt = build_option("search_path_cpp_headers")
-        if self.options.get("search-path-cpp-headers") is not None:
-            cpp_headers_mode = self.options.option("search-path-cpp-headers")
-            self.log.debug("search-path-cpp-headers set by toolchain option: %s", cpp_headers_mode)
-        elif build_opt is not None:
-            cpp_headers_mode = build_opt
-            self.log.debug("search-path-cpp-headers set by build option: %s", cpp_headers_mode)
-
-        if cpp_headers_mode not in SEARCH_PATH_CPP_HEADERS:
-            raise EasyBuildError(
-                "Unknown value selected for option search-path-cpp-headers: %s. Choose one of: %s",
-                cpp_headers_mode, ", ".join(SEARCH_PATH_CPP_HEADERS)
-            )
-
-        for env_var in SEARCH_PATH_CPP_HEADERS[cpp_headers_mode]:
+        for env_var in SEARCH_PATH["cpp_headers"][self.search_path["cpp_headers"]]:
             self.log.debug("Adding header paths to toolchain variable '%s': %s", env_var, dep_root)
             self.variables.append_subdirs(env_var, dep_root, subdirs=header_dirs)
 
@@ -1125,24 +1132,7 @@ def _add_dependency_linker_paths(self, dep_root, extra_dirs=None):
         lib_dirs = ["lib64", "lib"]
         lib_dirs = unique_ordered_extend(lib_dirs, extra_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]:
+        for env_var in SEARCH_PATH["linker"][self.search_path["linker"]]:
             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)