2023.1: troubleshoot/errata CMake Error

[Michael_C_Intel1]

Troubleshoot/Errata

*Update 20230525*: Please acquire the 2023.1.1 Rendering Toolkit update from the download page or from Intel repositories. This update fixes the Embree CMake file issue described in this errata forum post. All other Embree library contents are the same.

-----------------

2023.1.0 Messaging:

Embree cmake build files in the 2023.1.0 toolkit release contain mismatched paths. This has been observed to yield build errors in the 2023.1.0 release of the toolkit. Here is the 2023.1.0 symptom when building an Embree program:

CMake Error at /opt/intel/oneapi/embree/latest/lib/cmake/embree/embree-config.cmake:97 (INCLUDE):

  INCLUDE could not find requested file:

    /opt/intel/oneapi/embree/latest/lib/cmake/embree-4.0.1/embree_sycl-targets.cmake

Call Stack (most recent call first):

  CMakeLists.txt:18 (find_package)

CMake Error at /opt/intel/oneapi/embree/latest/lib/cmake/embree/embree-config.cmake:101 (INCLUDE):

  INCLUDE could not find requested file:

    /opt/intel/oneapi/embree/latest/lib/cmake/embree-4.0.1/embree-targets.cmake
Call Stack (most recent call first):
  CMakeLists.txt:18 (find_package)

A mitigation to remove an inaccurate file reference is described below. Note: Change the file paths to that of your 2023.1 toolkit installation directory as needed:

1. Backup embree-config.cmake:

Linux/macOS terminal:

sudo cp /opt/intel/oneapi/embree/4.0.1/lib/cmake/embree/embree-config.cmake /opt/intel/oneapi/embree/4.0.1/lib/cmake/embree/embree-config.cmake-orig

On Windows launch a Windows cmd.exe shell. Run it as administrator if your oneAPI install is in an administrator owned path. Backup the file:

copy "C:\Program Files (x86)\Intel\oneAPI\embree\4.0.1\lib\cmake\embree\embree-config.cmake" "C:\Program Files (x86)\Intel\oneAPI\embree\4.0.1\lib\cmake\embree\embree-config.cmake-orig"

2. Apply Edits:

2a. Either Manually edit the file:

Linux/macOS/minGW-style terminal

sudo sed -i ‘s/-4.0.1//g’ /opt/intel/oneapi/embree/4.0.1/lib/cmake/embree/embree-config.cmake

               Windows powershell (Run powershell as administrator as needed)

(Get-Content "C:\Program Files (x86)\Intel\oneAPI\embree\4.0.1\lib\cmake\embree\embree-config.cmake").replace('-4.0.1', '') | Set-Content "C:\Program Files (x86)\Intel\oneAPI\embree\4.0.1\lib\cmake\embree\embree-config.cmake"

2b.  OR on Linux/macOS you have the ‘patch’ utility… save the attached embree-config.txt (patch) and process the patch:

patch /opt/intel/oneapi/embree/4.0.1/lib/cmake/embree/embree-config.cmake < /path/to/patch/embree-config.txt

Note: Change the paths as needed in the patch.

3. Retry the Embree getting started guide (Windows/Linux/macOS/repository) to ensure functionality.