Skip to content

[NFC] Update OpenCL installation process #2201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 30, 2020
Merged

[NFC] Update OpenCL installation process #2201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e871107
[NFC] Update OpenCL installation process
vladimirlaz Jul 29, 2020
00e1e69
Apply suggestions from code review
vladimirlaz Jul 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 37 additions & 19 deletions sycl/doc/GetStartedGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,37 +166,37 @@ To run DPC++ applications on Level Zero devices, Level Zero implementation(s)
must be present in the system. You can find the link to the Level Zero spec in
the following section [Find More](#find-more).

The Level Zero RT for `GPU`, OpenCL RT for `GPU`, OpenCL RT for `CPU` and TBB runtime
which are needed to run DPC++ application on Intel `GPU` or Intel `CPU` devices can be
downloaded using links in
The Level Zero RT for `GPU`, OpenCL RT for `GPU`, OpenCL RT for `CPU`, FPGA
emulation RT and TBB runtime which are needed to run DPC++ application
on Intel `GPU` or Intel `CPU` devices can be downloaded using links in
[the dependency configuration file](../../buildbot/dependency.conf)
and installed following the instructions below. The same versions are used in
PR testing.

Intel OpenCL RT for `CPU` devices can be switched into OpenCL runtime for
Intel FPGA Emulation. The following parameter should be set in `cl.cfg` file
(available in directory containing CPU runtime for OpenCL) or environment
variable with the same name. The following value should be set to switch
OpenCL device mode:

```bash
CL_CONFIG_DEVICES = fpga-emu
```

**Linux**:

1) Extract the archive. For example, for the archive
`oclcpu_rt_<cpu_version>.tar.gz` you would run the following commands
1) Extract the archive. For example, for the archives
`oclcpuexp_<cpu_version>.tar.gz` and `fpgaemu_<fpga_version>.tar.gz` you would
run the following commands

```bash
# Extract OpenCL FPGA emulation RT
mkdir -p /opt/intel/oclfpgaemu_<fpga_version>
cd /opt/intel/oclfpgaemu_<fpga_version>
tar zxvf fpgaemu_<fpga_version>.tar.gz
# Extract OpenCL CPU RT
mkdir -p /opt/intel/oclcpuexp_<cpu_version>
cd /opt/intel/oclcpuexp_<cpu_version>
tar -zxvf oclcpu_rt_<cpu_version>.tar.gz
```

2) Create ICD file pointing to the new runtime
2) Create ICD file pointing to the new runtime (requires root access)

```bash
# OpenCL FPGA emulation RT
echo /opt/intel/oclfpgaemu_<fpga_version>/x64/libintelocl_emu.so >
/etc/OpenCL/vendors/intel_fpgaemu.icd
# OpenCL CPU RT
echo /opt/intel/oclcpuexp_<cpu_version>/x64/libintelocl.so >
/etc/OpenCL/vendors/intel_expcpu.icd
```
Expand All @@ -213,6 +213,16 @@ CL_CONFIG_DEVICES = fpga-emu
folder:

```bash
# OpenCL FPGA emulation RT
ln -s /opt/intel/tbb_<tbb_version>/tbb/lib/intel64/gcc4.8/libtbb.so
/opt/intel/oclfpgaemu_<fpga_version>/x64
ln -s /opt/intel/tbb_<tbb_version>/tbb/lib/intel64/gcc4.8/libtbbmalloc.so
/opt/intel/oclfpgaemu_<fpga_version>/x64
ln -s /opt/intel/tbb_<tbb_version>/tbb/lib/intel64/gcc4.8/libtbb.so.2
/opt/intel/oclfpgaemu_<fpga_version>/x64
ln -s /opt/intel/tbb_<tbb_version>/tbb/lib/intel64/gcc4.8/libtbbmalloc.so.2
/opt/intel/oclfpgaemu_<fpga_version>/x64
# OpenCL CPU RT
ln -s /opt/intel/tbb_<tbb_version>/tbb/lib/intel64/gcc4.8/libtbb.so
/opt/intel/oclcpuexp_<cpu_version>/x64
ln -s /opt/intel/tbb_<tbb_version>/tbb/lib/intel64/gcc4.8/libtbbmalloc.so
Expand All @@ -223,10 +233,12 @@ folder:
/opt/intel/oclcpuexp_<cpu_version>/x64
```

5) Configure library paths
5) Configure library paths (requires root access)

```bash
echo /opt/intel/oclcpuexp_<cpu_version>/x64 >
echo /opt/intel/oclfpgaemu_<fpga_version>/x64 >
/etc/ld.so.conf.d/libintelopenclexp.conf
echo /opt/intel/oclcpuexp_<cpu_version>/x64 >>
/etc/ld.so.conf.d/libintelopenclexp.conf
ldconfig -f /etc/ld.so.conf.d/libintelopenclexp.conf
```
Expand All @@ -239,7 +251,8 @@ OpenCL runtime for Intel `GPU` installer may re-write some important
files or settings and make existing OpenCL runtime for Intel `CPU` runtime
not working properly.

2) Extract the archive with OpenCL runtime for Intel `CPU` using links in
2) Extract the archive with OpenCL runtime for Intel `CPU` and/or for Intel
`FPGA` emulation using links in
[the dependency configuration file](../../buildbot/dependency.conf). For
example, to `c:\oclcpu_rt_<cpu_version>`.

Expand All @@ -257,6 +270,11 @@ extracted files are in `c:\oclcpu_rt_<cpu_version>\` folder, then type the
command:

```bash
# Install OpenCL FPGA emulation RT
# Answer N to clean previous OCL_ICD_FILENAMES configuration
c:\oclfpga_rt_<fpga_version>\install.bat c:\tbb_<tbb_version>\tbb\bin\intel64\vc14
# Install OpenCL CPU RT
# Answer Y to setup CPU RT side-bi-side with FPGA RT
c:\oclcpu_rt_<cpu_version>\install.bat c:\tbb_<tbb_version>\tbb\bin\intel64\vc14
```

Expand Down
36 changes: 32 additions & 4 deletions sycl/tools/install.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
@echo off

setlocal EnableDelayedExpansion
set OCL_RT_DIR=%~dp0

echo ###
echo ### 1. Save and update OpenCL.dll available in the system
echo ###
set TMP_FILE=%TEMP%\install.bat.tmp

set OCL_RT_ENTRY_LIB=%OCL_RT_DIR%intelocl64.dll
IF NOT EXIST %OCL_RT_ENTRY_LIB% (
set OCL_RT_ENTRY_LIB=%OCL_RT_DIR%intelocl64_emu.dll
)

IF "%OCL_ICD_FILENAMES%" == "" (
set EXTENDEXISTING=N
) else (
echo OCL_ICD_FILENAMES is present and contains %OCL_ICD_FILENAMES%
:USERINPUT
set /P "EXTENDEXISTING=Should the OpenCL RT extend existing configuration (Y/N): "
)
IF "%EXTENDEXISTING%" == "N" (
echo Clean up previous configuration
set OCL_ICD_FILENAMES=%OCL_RT_ENTRY_LIB%
) else (
IF "%EXTENDEXISTING%" == "Y" (

set OCL_ICD_FILENAMES=%OCL_ICD_FILENAMES%;%OCL_RT_ENTRY_LIB%
echo Extend previous configuration to %OCL_ICD_FILENAMES%;%OCL_RT_ENTRY_LIB%
) else (
echo WARNING: Incorrect input %EXTENDEXISTING%. Only Y and N are allowed.
goto USERINPUT
)
)


set SYSTEM_OCL_ICD_LOADER=C:\Windows\System32\OpenCL.dll
set NEW_OCL_ICD_LOADER=%OCL_RT_DIR%\OpenCL.dll
Expand Down Expand Up @@ -73,11 +99,13 @@ IF %NEED_OPENCL_UPGRADE% == True (
echo System OpenCL.dll is already new, no need to upgrade it.
)



echo.
echo ###
echo ### 3. Set the environment variable OCL_ICD_FILENAMES to %OCL_ICD_FILENAMES%
echo ###
REG ADD "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /v OCL_ICD_FILENAMES /d "%OCL_ICD_FILENAMES%"
REG ADD "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /f /v OCL_ICD_FILENAMES /d "%OCL_ICD_FILENAMES%"
IF ERRORLEVEL 1 (
echo !!! Cannot set the environment variable OCL_ICD_FILENAMES
set INSTALL_ERRORS=1
Expand Down Expand Up @@ -137,7 +165,7 @@ IF %INSTALL_ERRORS% == 1 (
echo See recommendations printed above and perform the following actions manually:
echo 1. Save %SYSTEM_OCL_ICD_LOADER% to %SYSTEM_OCL_ICD_LOADER%.%SYSTEM_OPENCL_VER%
echo 2. Copy %NEW_OCL_ICD_LOADER% to %SYSTEM_OCL_ICD_LOADER%
echo 3. Add/set the environment variable OCL_ICD_FILENAMES to %OCL_RT_DIR%intelocl64.dll
echo 3. Add/set the environment variable OCL_ICD_FILENAMES to %OCL_RT_ENTRY_LIB%
echo 4. Copy TBB libraries or create symbolic links in %OCL_RT_DIR%tbb.
echo 5. Add/set the environment variable PATH to %OCL_RT_DIR%tbb
echo Or try running this batch file as Administrator.
Expand All @@ -147,5 +175,5 @@ IF %INSTALL_ERRORS% == 1 (
echo.

endlocal& ^
set OCL_ICD_FILENAMES=%OCL_RT_DIR%intelocl64.dll
set OCL_ICD_FILENAMES=%OCL_ICD_FILENAMES%
set "PATH=%PATH%;%OCL_RT_DIR%\tbb"