Skip to content

Commit 56c00a0

Browse files
GetStartedGuide.md update
- ESIMD CPU emulation is added
1 parent 293ad43 commit 56c00a0

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

sycl/doc/GetStartedGuide.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ and a wide range of compute accelerators such as GPU and FPGA.
1111
- [Build DPC++ toolchain with support for NVIDIA CUDA](#build-dpc-toolchain-with-support-for-nvidia-cuda)
1212
- [Build DPC++ toolchain with support for AMD ROCm](#build-dpc-toolchain-with-support-for-amd-rocm)
1313
- [Build DPC++ toolchain with support for NVIDIA ROCm](#build-dpc-toolchain-with-support-for-nvidia-rocm)
14+
- [Build DPC++ toolchain with support for ESIMD CPU Emulation](#build-dpc-toolchain-with-support-for-esimd-cpu)
1415
- [Build Doxygen documentation](#build-doxygen-documentation)
1516
- [Deployment](#deployment)
1617
- [Use DPC++ toolchain](#use-dpc-toolchain)
@@ -109,6 +110,7 @@ flags can be found by launching the script with `--help`):
109110
* `--cuda` -> use the cuda backend (see [Nvidia CUDA](#build-dpc-toolchain-with-support-for-nvidia-cuda))
110111
* `--rocm` -> use the rocm backend (see [AMD ROCm](#build-dpc-toolchain-with-support-for-amd-rocm))
111112
* `--rocm-platform` -> select the platform used by the rocm backend, `AMD` or `NVIDIA` (see [AMD ROCm](#build-dpc-toolchain-with-support-for-amd-rocm) or see [NVIDIA ROCm](#build-dpc-toolchain-with-support-for-nvidia-rocm))
113+
* '--enable-esimd-cpu-emulation' -> enable ESIMD CPU emulation (See [Build DPC++ toolchain with support for ESIMD CPU Emulation])
112114
* `--shared-libs` -> Build shared libraries
113115
* `-t` -> Build type (debug or release)
114116
* `-o` -> Path to build directory
@@ -206,6 +208,48 @@ as well as CUDA to be installed, see
206208
Currently this was only tested on Linux with ROCm 4.2, CUDA 11 and a GeForce GTX
207209
1060 card.
208210

211+
### Build DPC++ toolchain with support for ESIMD CPU Emulation
212+
213+
There is experimental support for DPC++ for using ESIMD CPU Emulation
214+
215+
This feature supports ESIMD CPU Emulation using CM_EMU library [CM
216+
Emulation
217+
project](https://github.com/intel/cm-cpu-emulation). Pre-built library
218+
package will be downloaded and installed in your deploy directory
219+
during toolchain build.
220+
221+
To enable support for ESIMD CPU emulation, follow the instructions for
222+
the Linux DPC++ toolchain, but add the `--enable-esimd-cpu-emulation'.
223+
224+
Enabling this flag requires following packages installed.
225+
226+
* Ubuntu 20.04
227+
* libva-dev / 2.7.0-2
228+
* libva-drm2 / 2.7.0-2
229+
* libva-glx2 / 2.7.0-2
230+
* libva-wayland2 / 2.7.0-2
231+
* libva-x11-2 / 2.7.0-2
232+
* libva2 / focal 2.7.0-2
233+
* libffi-dev / 3.3-4
234+
* libffi7 / 3.3-4
235+
* libdrm-amdgpu1
236+
* libdrm-common
237+
* libdrm-dev
238+
* libdrm-intel1
239+
* libdrm-nouveau2
240+
* libdrm-radeon1
241+
* libdrm2
242+
* RHEL 8.*
243+
* libffi
244+
* libffi-devel
245+
* libdrm
246+
* libdrm-devel
247+
* libva
248+
* libva-devel
249+
250+
Currently, this feature was tested and verified on Ubuntu 20.04
251+
environment.
252+
209253
### Build Doxygen documentation
210254

211255
Building Doxygen documentation is similar to building the product itself. First,

0 commit comments

Comments
 (0)