You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sycl/doc/extensions/experimental/sycl_ext_intel_esimd/esimd_emulator.md
+27-9Lines changed: 27 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -44,11 +44,29 @@ during ESIMD_EMULATOR plug-in software module generation. Details on
44
44
building CM_EMU library for ESIMD_EMULATOR such as required packages
45
45
are described in [ESIMD CPU Emulation](https://github.com/intel/llvm/blob/sycl/sycl/doc/GetStartedGuide.md#build-dpc-toolchain-with-support-for-esimd-cpu-emulation)
46
46
47
-
## Command line option / environment variable options
48
-
49
-
There is no special command line option or environment variable
50
-
required for building and running ESIMD kernels with ESIMD_EMULATOR
51
-
backend.
47
+
## Environment variable
48
+
49
+
For running ESIMD kernels with the ESIMD_EMULATOR backend, the CM_EMU
50
+
library requires 'CM_RT_PLATFORM' environment variable set in order to
51
+
specify the target platform you want to emulate.
52
+
53
+
> `$ export CM_RT_PLATFORM=SKL`
54
+
55
+
List of target platforms supported by CM_EMU is as follows
56
+
57
+
- SKL
58
+
- BXT
59
+
- KBL
60
+
- ICLLP
61
+
- TGLLP
62
+
- RKL
63
+
- DG1
64
+
- ADLP
65
+
- ADLS
66
+
- ADLN
67
+
- DG2
68
+
- MTL
69
+
- PVC
52
70
53
71
## Running ESIMD code under emulation mode
54
72
@@ -64,15 +82,15 @@ To compile using Intel(R) OneAPI Toolkit:
64
82
> `$ dpcpp vadd_usm.cpp`
65
83
66
84
To run under emulation through ESIMD_EMULATOR backend:
Please note that ESIMD_EMULATOR backend cannot be picked up as default
70
88
device automatically. To enable it, `ext_intel_esimd_emulator:gpu` device must
71
-
be specified among other devices explicitly in `SYCL_DEVICE_FILTER` environment
89
+
be specified among other devices explicitly in `ONEAPI_DEVICE_SELECTOR` environment
72
90
variable. The emulator device effectively replaces any Intel GPU device for SYCL runtime,
73
91
so they can't be used simultaneously by a SYCL offload application process. On the other
74
92
hand, it is OK to mix the emulator with non-Intel GPU devices or CPU device in
75
-
`SYCL_DEVICE_FILTER`.
93
+
`ONEAPI_DEVICE_SELECTOR`.
76
94
77
95
## Running ESIMD examples from [ESIMD test suite](https://github.com/intel/llvm-test-suite/tree/intel/SYCL/ESIMD) on github with ESIMD_EMULATOR backend
78
96
@@ -108,7 +126,7 @@ ninja check
108
126
109
127
Note that only [ESIMD Kernels](https://github.com/intel/llvm-test-suite/tree/intel/SYCL/ESIMD) are
110
128
tested with above command examples due to ESIMD_EMULATOR's limitations
111
-
below.
129
+
below. And, if 'CM_RT_PLATFORM' is not set, 'skl' is set by default.
112
130
113
131
## Limitation
114
132
- The emulator is available only on Linux for now. Windows support is WIP.
0 commit comments