Missing compiler Environment Modules Utility files in Intel(R) oneAPI for Linux version 2023.2.0

[Ron_Green]

Products and Packages Affected:

Intel(R) oneAPI toolkits for Linux* with compiler components, and stand-alone compiler components.  This affects version 2023.2.0 packages, compiler versions 2023.2.0 and 2021.10.0

Update 01 August 2023: Fix provided in 2023.2.1 Compiler Patch release

Two patches are now available, one for each of the Intel C++ and Fortran compilers, that were published as part of oneAPI 2023.2:

* Intel® oneAPI DPC+/C+ Compiler and Intel® C++ Compiler Classic
* Intel® Fortran Compiler Classic and Intel® Fortran Compiler

The patch version is 2023.2.1.

These patches apply only to Linux* and Windows*.

These patches resolve the issue of missing Environment Modules utility modulefiles and other issues.

The patches are available on the Intel® Registration Center, other distribution channels, like APT, YUM, and the standalone component page.

If you cannot update your installation with this 2023.2.1 patch release, and have version 2023.2.0, please continue reading.  

Symptoms v2023.2.0 and v2021.10.0

If you try to 'module load' <oneapi root>/modulefiles/compiler/latest or <oneapi root>/modulefiles/compiler/2023.2.0 you will get an error that the file is not found and your environment is not set for the compilers.

Does This Impact My Work?

This only affects Linux compiler users.  Windows users are not impacted.  For Linux users, you are only impacted if you use The Environment Modules utilities from LMOD or Sourceforge.  If you are not aware of the 'module' command utility and you use the environment scripts 'setvars.sh' or 'vars.sh' to set environment, you are not affected - this information is not applicable to you and you need not take any action (you can stop reading now).

If you do set up or use the 'module' commands for environment setting, read on.

Missing Files

The following files for the support of the Environment Module Utility for the Intel(R) oneAPI compilers are missing in the Linux Intel(R) oneAPI packages in directory <oneapi root>/compiler/latest/modulefiles/

compiler
compiler32
compiler-rt
compiler-rt32
icc
icc32

In addition, there is a broken symbolic link in the modulefiles directory <oneapi root>/compiler/latest/modulefiles/ that is no longer used and can be deleted.

init-opencl-> ../linux/lib/oclfpga/modulefiles/init_opencl

Workarounds and Solution

Intel is working on a fix that includes these missing files.  These files will appear in a future update to the compiler packages.  In the meantime, the following workarounds are recommended.

The broken symbolic link 'init-opencl' can simply be removed, it is no longer needed for correct functioning of the compilers.

If you have a side-by-side installation of 2023.0.0 or 2023.1.0, use this workaround:

cd /opt/intel/oneapi/compiler/2023.2.0/modulefiles

# if you have a non-default root dir for oneapi, 
#   cd to the compiler/2023.2.0/modulefiles directory.
# first, remove the unneeded sym link 'init_opencl'

rm init_opencl

# COPY the 2023.1.0 or 2023.0.0 modulefiles to this directory.  
# here is an example using the last good version of 2023.1.0

cp /opt/intel/oneapi/compiler/2023.1.0/modulefiles/*  . 

# this should bring over needed files.
# 
# Final step, re-run 'modulefiles-setup.sh'

cd /opt/intel/oneapi
./modulefiles-setup.sh

# this re-makes the sym links in <oneapi root>/modulefiles/ to include a link 
#    'compiler/latest' that is linked to the actual file 
#    compiler/2023.2.0/modulefiles/compiler

Workaround If You Do Not Have an Existing 2023.1.0 or 2023.0.0 Installation

We have attached file 'modulefiles-2023.1.0-linux.tgz' to this article.  Download this file. Place in a temporary directory, such as your home dir.  We assume home directory for the following instructions.:

cd /opt/intel/oneapi/compiler/2023.2.0/modulefiles

# if you have a non-default root dir for oneapi, 
#   cd to the compiler/2023.2.0/modulefiles directory.
# first, remove the unneeded sym link 'init_opencl'

rm init_opencl

# untar the file 'modulefiles-2023.1.0-linux.tgz' here:

  tar -zxvf ~/modulefiles-2023.1.0-linux.tgz

# this should bring over needed files.
# Now add the sym link for 'oclfpga'

ln -s ../linux/lib/oclfpga/modulefiles/oclfpga oclfpga

# Final step, re-run 'modulefiles-setup.sh'

cd /opt/intel/oneapi
./modulefiles-setup.sh

# this re-makes the sym links in <oneapi root>/modulefiles/ to include a link 
#    'compiler/latest' that is linked to the actual file 
#    compiler/2023.2.0/modulefiles/compiler

Long-term Solution: A Fix is Coming

Intel is preparing a patch release for the compilers that will include the missing modulefiles.  We will post a notice when this update is ready to install.

What are Environment Modules

The Environment Modules utility allows dynamic modification of a user environment (shell environment variables such as PATH, LD_LIBRARY_PATH, etc). The Environment Module utility works with a set of system or user configure "modulefiles" which specify the necessary environment settings necessary to use a particular development tool or toolset, such as Intel® onAPI.   More information on the Environment Utility and modulefiles can be found here http://modules.sourceforge.net/

[Gusman]

Hello Ron,

After downloading the archive file 'modulefiles-2023.1.0.tgz' the tar archiver throws lots of error messages:

$ tar -tzf modulefiles-2023.1.0.tgz
._compiler
tar: Ignoring unknown extended header keyword 'LIBARCHIVE.xattr.com.apple.quarantine'
tar: Ignoring unknown extended header keyword 'LIBARCHIVE.xattr.com.apple.quarantine'

Platform: Ubuntu 20.04.6 LTS

Any idea how these errors messages can be resolved?

Unfortunately, I was so naive to remove the old Intel oneAPI Toolkit version 2023.1.0 and then recreate the modulefiles directory for the new version 2023.2.0, thus all previously existing modulefiles were lost.

Cheers,

Gusman

[Ron_Green]

@Gusman I uploaded a new tar file 'modulefiles-2023.1.0-linux.tgz

the previous tar file was created on a macOS system.  This new tar file was created on a Linux system.  Give this one a try.

[Gusman]

Hello Ron,

Thank you for your prompt response and for your kind assistance. I downloaded the new 'modulefiles-2023.1.0-linux.tgz' and I was able to unpack the file and to add the modulefiles to the Intel oneAPI Toolkit version 2023.2.0 without any problems. Thanks again for your kind help!

Best,

Gusman

[nmnobre]

Hi @Ron_Green,

The modulefile for the MPI component, version 2021.10.0, is also broken. Copying the last good version in 2023.1.0 seems to work.

It would be nice if we could have a new, minor release, e.g. 2023.2.1, to address these issues.

Cheers,

Nuno

[Ron_Green]

what was the error you saw in MPI?  Compile time error or runtime error?  What was the error output?

[nmnobre]

It's simpler than that.
The modulefile is adding completely incorrect directories to the environment paths, so loading it has no effect whatsoever.

For instance, instead of /path/to/intel/oneapi/2023.2.0/mpi/2021.10.0/bin, the module is prepending /path/to/intel/oneapi/2023.2.0/mpi/intel64/bin to the PATH environment variable.

Cheers,

Nuno

[Ron_Green]

Thanks @nmnobre I'll alert my colleagues on the MPI team.

[nmnobre]

Hi @Ron_Green,

I see the MPI module fix didn't make it to the 2023.2.1 patch release, I was a couple of days too late.

For people without a paid license who download the toolkits from their main webpages, how can we get the patch?

Is Intel planning to release the full packages there as well?

Cheers,

Nuno

[Barbara_P_Intel]

The patch is available on the standalone component page. Look in the Compilers section.

[QuantumMisaka]

Now the newest MKL and Compiler is not in miss, but MPI is still cannot be loaded by using `module load`

[Barbara_P_Intel]

Yes, there remains an issue with MPI and "module load". There is discussion on the HPC Toolkit Forum about this. That forum answers questions about MPI.