Make setting CHPL_* environment variables to invalid values an error (#26501)

Makes most CHPL_* environment variables produce an error if set to an
invalid value. This can help prevent user error when accidentally doing
the wrong thing.

For example, a user might misspell something or just misunderstand how
to set a variable. Previously, we would just silently take that value
and maybe break in expected ways later. Now, we refuse to accept it and
tell the user exactly what they did wrong


Previously,
```bash
export CHPL_LLVM=ssystem
make # error, cannot find Makefile.include-ssystem
```

Now,
```bash
export CHPL_LLVM=ssystem
make # Error: CHPL_LLVM=ssystem is not valid, CHPL_LLVM must be none, bundled, or system
```

[Reviewed by @mppf]

Author: jabraham17

util/chplenv/chpl_atomics.py

@@ -4,7 +4,7 @@
 
 import chpl_comm, chpl_compiler, chpl_platform, overrides
 from compiler_utils import CompVersion, get_compiler_version, has_std_atomics
-from utils import error, memoize, warning
+from utils import error, memoize, warning, check_valid_var
 
 
 @memoize
@@ -21,7 +21,7 @@ def get(flag='target'):
         elif atomics_val == 'gasnet':
             error("CHPL_NETWORK_ATOMICS=gasnet is not supported")
         elif atomics_val not in valid:
-            error("CHPL_NETWORK_ATOMICS must be one of " + ','.join(valid))
+            check_valid_var("CHPL_NETWORK_ATOMICS", atomics_val, valid)
         elif atomics_val != 'none' and atomics_val != comm_val:
             error("CHPL_NETWORK_ATOMICS=%s is incompatible with CHPL_COMM=%s"
                   % (atomics_val, comm_val))
@@ -82,6 +82,9 @@ def get(flag='target'):
             # we can't use intrinsics, fall back to locks
             if not atomics_val:
                 atomics_val = 'locks'
+
+        check_valid_var("CHPL_ATOMICS", atomics_val, ['cstdlib', 'intrinsics', 'locks'])
+
     else:
         error("Invalid flag: '{0}'".format(flag), ValueError)
 

util/chplenv/chpl_aux_filesys.py

@@ -4,12 +4,13 @@
 from glob import glob
 
 import overrides
-from utils import memoize
+from utils import memoize, check_valid_var
 
 
 @memoize
 def get():
     aux_fs = overrides.get('CHPL_AUX_FILESYS', 'none')
+    check_valid_var('CHPL_AUX_FILESYS', aux_fs, ['none', 'lustre'])
     return aux_fs
 
 

util/chplenv/chpl_comm.py

@@ -4,8 +4,8 @@
 import re
 import shutil
 
-import overrides
-from utils import memoize
+import chpl_platform, overrides
+from utils import memoize, check_valid_var
 
 
 @memoize
@@ -38,6 +38,7 @@ def get():
             else:
                 comm_val = 'none'
 
+    check_valid_var("CHPL_COMM", comm_val, ("none", "gasnet", "ofi", "ugni"))
     return comm_val
 
 

util/chplenv/chpl_comm_ofi_oob.py

@@ -7,7 +7,7 @@
 import overrides
 import third_party_utils
 
-from utils import error, memoize
+from utils import error, memoize, check_valid_var
 
 @memoize
 def _find_pmi2():
@@ -41,33 +41,30 @@ def get():
         return 'none'
 
     oob_val = overrides.get('CHPL_COMM_OFI_OOB')
-    if oob_val:
-        if oob_val not in ('mpi', 'pmi2', 'sockets'):
-            error("CHPL_COMM_OFI_OOB must be 'mpi', 'pmi2', or 'sockets'")
-        return oob_val
-
-    #
-    # By default, use PMI2 out-of-band support on Cray X* and HPE Cray EX
-    # systems, MPI on other Cray systems or with an MPI-based launcher,
-    # and "sockets" otherwise.
-    #
-    platform_val = chpl_platform.get('target')
-    launcher_val = chpl_launcher.get()
-    if 'cray-x' in platform_val or chpl_platform.is_hpe_cray('target'):
-        oob_val = 'pmi2'
-    elif 'cray-' in platform_val:
-        oob_val = 'mpi'
-    elif 'mpi' in launcher_val:
-        oob_val = 'mpi'
-    else:
-        import chpl_compiler
-        if _find_pmi2() is not None:
-            oob_val = 'pmi2'
-        elif "-lpmi2" in chpl_compiler.get_system_link_args('target'):
+    if not oob_val:
+        #
+        # By default, use PMI2 out-of-band support on Cray X* and HPE Cray EX
+        # systems, MPI on other Cray systems or with an MPI-based launcher,
+        # and "sockets" otherwise.
+        #
+        platform_val = chpl_platform.get('target')
+        launcher_val = chpl_launcher.get()
+        if 'cray-x' in platform_val or chpl_platform.is_hpe_cray('target'):
             oob_val = 'pmi2'
+        elif 'cray-' in platform_val:
+            oob_val = 'mpi'
+        elif 'mpi' in launcher_val:
+            oob_val = 'mpi'
         else:
-            oob_val = 'sockets'
-
+            import chpl_compiler
+            if _find_pmi2() is not None:
+                oob_val = 'pmi2'
+            elif "-lpmi2" in chpl_compiler.get_system_link_args('target'):
+                oob_val = 'pmi2'
+            else:
+                oob_val = 'sockets'
+
+    check_valid_var("CHPL_COMM_OFI_OOB", oob_val, ("mpi", "pmi2", "sockets"))
     return oob_val
 
 # returns 2-tuple of lists

util/chplenv/chpl_comm_segment.py

@@ -2,7 +2,7 @@
 import sys
 
 import chpl_comm, chpl_comm_substrate, chpl_platform, overrides
-from utils import memoize
+from utils import memoize, check_valid_var
 
 
 @memoize
@@ -21,6 +21,7 @@ def get():
                 segment_val = 'large'
             else:
                 segment_val = 'everything'
+        check_valid_var("CHPL_GASNET_SEGMENT", segment_val, ("fast", "large", "everything"))
     else:
         segment_val = 'none'
     return segment_val

util/chplenv/chpl_comm_substrate.py

@@ -2,8 +2,8 @@
 import sys
 import shutil
 
-import chpl_comm, overrides
-from utils import memoize
+import chpl_comm, chpl_platform, overrides
+from utils import memoize, check_valid_var
 
 
 @memoize
@@ -38,6 +38,8 @@ def get():
                     substrate_val = 'udp'
         else:
             substrate_val = 'none'
+
+    check_valid_var("CHPL_COMM_SUBSTRATE", substrate_val, ("none", "aries", "ofi", "ibv", "udp", "mpi"))
     return substrate_val
 
 

util/chplenv/chpl_gmp.py

@@ -5,7 +5,7 @@
 
 import chpl_compiler, chpl_platform, overrides, third_party_utils
 from chpl_home_utils import get_chpl_third_party
-from utils import memoize, warning, error
+from utils import memoize, warning, error, check_valid_var
 
 # returns True if CHPL_GMP was set by the user
 # (i.e. not inferred to be the default)
@@ -36,6 +36,7 @@ def get():
         else:
             gmp_val = 'none'
 
+    check_valid_var('CHPL_GMP', gmp_val, ['none', 'bundled', 'system'])
     return gmp_val
 
 @memoize

util/chplenv/chpl_gpu.py

@@ -8,7 +8,7 @@
 import chpl_tasks
 import chpl_home_utils
 import overrides
-from utils import error, warning, memoize, try_run_command, which, is_ver_in_range
+from utils import error, warning, memoize, try_run_command, which, is_ver_in_range, check_valid_var
 
 def _validate_cuda_version():
     return _validate_cuda_version_impl()
@@ -234,7 +234,7 @@ def get():
     chpl_gpu_env = overrides.get("CHPL_GPU")
     if chpl_gpu_env:
         if chpl_gpu_env not in GPU_TYPES:
-            error("Only {} supported for 'CHPL_GPU'".format(list(GPU_TYPES.keys())))
+            check_valid_var("CHPL_GPU", chpl_gpu_env, list(GPU_TYPES.keys()))
         else:
             return chpl_gpu_env
     else:

util/chplenv/chpl_hwloc.py

@@ -5,7 +5,7 @@
 import optparse
 import chpl_locale_model, chpl_tasks, chpl_platform, overrides, third_party_utils
 import chpl_hwloc_pci
-from utils import error, memoize, warning, try_run_command, run_command
+from utils import error, memoize, warning, try_run_command, run_command, check_valid_var
 
 
 @memoize
@@ -18,6 +18,7 @@ def get():
         else:
             hwloc_val = 'none'
 
+    check_valid_var('CHPL_HWLOC', hwloc_val, ['none', 'bundled', 'system'])
     return hwloc_val
 
 

util/chplenv/chpl_hwloc_pci.py

@@ -13,7 +13,7 @@
 import chpl_hwloc, chpl_comm, chpl_locale_model, chpl_gpu
 import overrides
 
-from utils import error, memoize
+from utils import error, memoize, check_valid_var
 
 @memoize
 def get():
@@ -33,6 +33,7 @@ def get():
                 gpu_val = chpl_gpu.get()
                 if gpu_val != 'cpu':
                     pci_val = 'enable'
+    check_valid_var('CHPL_HWLOC_PCI', pci_val, ['enable', 'disable'])
     return pci_val
 
 

util/chplenv/chpl_jemalloc.py

@@ -5,7 +5,7 @@
 
 import chpl_bin_subdir, chpl_compiler, chpl_mem, chpl_platform, overrides, third_party_utils
 import homebrew_utils
-from utils import error, memoize, run_command, warning
+from utils import error, memoize, run_command, warning, check_valid_var
 
 
 @memoize
@@ -53,11 +53,14 @@ def get(flag='target'):
         elif darwin and mem_val == 'jemalloc' and jemalloc_val == 'bundled':
             error("CHPL_HOST_JEMALLOC=bundled is not supported on Mac for host builds")
 
+    var_name = 'CHPL_{0}_JEMALLOC'.format(flag.upper())
+    mem_var_name = 'CHPL_{0}_MEM'.format(flag.upper())
     if mem_val == 'jemalloc' and jemalloc_val == 'none':
-        error("CHPL_JEMALLOC must not be 'none' when CHPL_TARGET_MEM is jemalloc")
+        error("{0} must not be 'none' when {0} is jemalloc".format(var_name, mem_var_name))
     elif mem_val != 'jemalloc' and jemalloc_val != 'none':
-        error("CHPL_JEMALLOC must be 'none' when CHPL_TARGET_MEM is not jemalloc")
+        error("{0} must be 'none' when {0} is not jemalloc".format(var_name, mem_var_name))
 
+    check_valid_var(var_name, jemalloc_val, ["none", "bundled", "system"])
     return jemalloc_val
 
 

util/chplenv/chpl_launcher.py

@@ -3,7 +3,7 @@
 import sys
 
 import chpl_comm, chpl_comm_substrate, chpl_platform, overrides
-from utils import which, error, memoize, warning
+from utils import which, error, memoize, warning, check_valid_var
 
 
 def slurm_prefix(base_launcher, platform_val):
@@ -69,6 +69,13 @@ def get():
     if launcher_val is None:
         launcher_val = 'none'
 
+    gasnet_launchers = ["mpi", "ibv", "ucx", "ofi"]
+    valid_values = ["none", "amudprun", "smp", "aprun", "slurm-srun"]
+    valid_values.extend(["lsf-gasnetrun_ibv", "mpirun", "mpirun4ofi", "pals", "pbs-aprun", "pbs-gasnetrun_ibv"])
+    valid_values.extend(["gasnetrun_{}".format(l) for l in gasnet_launchers])
+    valid_values.extend(["slurm-gasnetrun_{}".format(l) for l in gasnet_launchers])
+    check_valid_var("CHPL_LAUNCHER", launcher_val, valid_values)
+
     return launcher_val
 
 

util/chplenv/chpl_lib_pic.py

@@ -3,14 +3,12 @@
 
 import overrides
 import chpl_platform
-from utils import memoize
+from utils import memoize, check_valid_var
 
 @memoize
 def get():
-    lib_pic_val = overrides.get('CHPL_LIB_PIC')
-    if not lib_pic_val:
-        lib_pic_val = 'none'
-
+    lib_pic_val = overrides.get('CHPL_LIB_PIC', 'none')
+    check_valid_var("CHPL_LIB_PIC", lib_pic_val, ["none", "pic"])
     return lib_pic_val
 
 

util/chplenv/chpl_libfabric.py

@@ -6,7 +6,7 @@
 import chpl_comm, chpl_comm_debug, chpl_launcher, chpl_platform, chpl_comm_ofi_oob
 import overrides, third_party_utils
 
-from utils import error, memoize, try_run_command, warning
+from utils import error, memoize, try_run_command, warning, check_valid_var
 
 @memoize
 def get():
@@ -18,10 +18,11 @@ def get():
                 libfabric_val = 'system'
             else:
                 libfabric_val = 'bundled'
-        if libfabric_val == 'none':
-            error("CHPL_LIBFABRIC must not be 'none' when CHPL_COMM is ofi")
-        elif chpl_platform.is_hpe_cray('target') and libfabric_val != 'system':
+
+        check_valid_var('CHPL_LIBFABRIC', libfabric_val, ['bundled', 'system'])
+        if chpl_platform.is_hpe_cray('target') and libfabric_val != 'system':
             warning('CHPL_LIBFABRIC!=system is discouraged on HPE Cray')
+
     else:
         libfabric_val = 'none'
 

util/chplenv/chpl_llvm.py

@@ -9,7 +9,7 @@
 from chpl_home_utils import get_chpl_third_party, get_chpl_home
 import chpl_gpu
 import homebrew_utils
-from utils import which, memoize, error, run_command, try_run_command, warning
+from utils import which, memoize, error, run_command, try_run_command, warning, check_valid_var
 from collections import defaultdict
 
 # returns a tuple of supported major LLVM versions as strings
@@ -641,6 +641,9 @@ def has_compatible_installed_llvm():
 @memoize
 def get():
     llvm_val = overrides.get('CHPL_LLVM')
+    if llvm_val:
+        check_valid_var("CHPL_LLVM", llvm_val, ['none', 'bundled', 'system'])
+
     if not llvm_val:
         llvm_val = 'unset'
 

util/chplenv/chpl_locale_model.py

@@ -2,17 +2,13 @@
 import sys
 
 import overrides
-from utils import memoize, error
+from utils import memoize, error, check_valid_var
 
 
 @memoize
 def get():
     locale_model_val = overrides.get('CHPL_LOCALE_MODEL', 'flat')
-
-    if locale_model_val not in ['flat', 'gpu']:
-        error('{} is not a valid value for CHPL_LOCALE_MODEL. '
-              'It can only be "flat" or "gpu".'.format(locale_model_val))
-
+    check_valid_var("CHPL_LOCALE_MODEL", locale_model_val, ["flat", "gpu"])
     return locale_model_val
 
 

util/chplenv/chpl_mem.py

@@ -3,7 +3,7 @@
 import sys
 
 import chpl_platform, overrides
-from utils import error, memoize, warning
+from utils import error, memoize, warning, check_valid_var
 
 @memoize
 def get(flag='host'):
@@ -37,6 +37,9 @@ def get(flag='host'):
             mem_val = 'jemalloc'
     else:
         error("Invalid flag: '{0}'".format(flag), ValueError)
+
+    var_name = 'CHPL_{0}_MEM'.format(flag.upper())
+    check_valid_var(var_name, mem_val, ["cstdlib", "jemalloc"])
     return mem_val