[SYCL][ESIMD] Add ESIMD extension intro document. (#2502)

Signed-off-by: Konstantin S Bobrovsky <[email protected]>

Author: kbobrovs

sycl/doc/extensions/ExplicitSIMD/README.md

@@ -0,0 +1,93 @@
+# Intel "Explicit SIMD" SYCL extension
+
+OneAPI provides the "Explicit SIMD" SYCL extension (or simply "ESIMD") for
+lower-level Intel GPU programming. It provides APIs closely matching Intel GPU ISA
+yet allows to write explicitly vectorized device code. This helps programmer to
+have more control over the generated code and depend less on compiler
+optimizations. The [specification](https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/ExplicitSIMD/dpcpp-explicit-simd.md),
+[documented ESIMD APIs headers](https://github.com/intel/llvm/tree/sycl/sycl/include/CL/sycl/INTEL/esimd) and
+[working code examples](https://github.com/intel/llvm/blob/sycl/sycl/test/esimd/on-device) are available on the Intel DPC++ project's github.
+
+**_NOTE:_** _This extension is under active development and lots of APIs are
+subject to change. There are currenly a number of restrictions specified
+below._
+
+ESIMD kernels and functions always require the subgroup size of one, which means
+compiler never does vectorization across workitems in a subgroup. Instead,
+vectorization is experessed explicitly in the code by the programmer. Here is a
+trivial example which adds elements of two arrays and writes the results to the
+third:
+
+```cpp
+  float *A = static_cast<float *>(malloc_shared(Size * sizeof(float), dev, ctxt));
+  float *B = static_cast<float *>(malloc_shared(Size * sizeof(float), dev, ctxt));
+  float *C = static_cast<float *>(malloc_shared(Size * sizeof(float), dev, ctxt));
+
+  for (unsigned i = 0; i < Size; ++i) {
+    A[i] = B[i] = i;
+  }
+
+  // We need that many workitems. Each processes VL elements of data.
+  cl::sycl::range<1> GlobalRange{Size / VL};
+  // Number of workitems in each workgroup.
+  cl::sycl::range<1> LocalRange{GroupSize};
+
+  cl::sycl::nd_range<1> Range(GlobalRange, LocalRange);
+
+  auto e = q.submit([&](handler &cgh) {
+    cgh.parallel_for<class Test>(Range, [=](nd_item<1> ndi) SYCL_ESIMD_KERNEL {
+      using namespace sycl::INTEL::gpu;
+
+      int i = ndi.get_global_id(0);
+      simd<float, VL> va = block_load<float, VL>(A + i * VL);
+      simd<float, VL> vb = block_load<float, VL>(B + i * VL);
+      simd<float, VL> vc = va + vb;
+      block_store<float, VL>(C + i * VL, vc);
+    });
+  });
+```
+
+In this example the lambda function passed to the `parallel_for` is marked with
+a special attribute - `SYCL_ESIMD_KERNEL`. This tells the compiler that this
+kernel is a ESIMD one and ESIMD APIs can be used inside it. Here the `simd`
+objects and `block_load`/`block_store` intrinsics are used which are avaiable
+only in the ESIMD extension.
+Full runnable code sample can be found on the
+[github repo](https://github.com/intel/llvm/blob/sycl/sycl/test/esimd/on-device/vadd_usm.cpp).
+
+#### Compiling and running ESIMD code.
+To compile a code which uses the ESIMD extension, a special compiler switch
+`-fsycl-explicit-simd` switch must be used:
+
+> `$ clang++ -fsycl -fsycl-explicit-simd vadd_usm.cpp`
+
+The resulting executable can only be run on Intel GPU hardware, such as
+Intel HD Graphics 600 or later. To run it, couple additional environment
+variables must be used - `SYCL_BE=PI_OPENCL` and
+`SYCL_PROGRAM_COMPILE_OPTIONS=-vc-codegen`:
+
+> `$ SYCL_BE=PI_OPENCL SYCL_PROGRAM_COMPILE_OPTIONS=-vc-codegen ./a.out`
+
+#### Restrictions
+
+Here is a list of main restrictions imposed on using ESIMD extension. Note that
+some of them are not enforced by the compiler, which may lead to undefined
+program behavior if violated.
+
+##### Features not supported with ESIMD extension:
+- Windows target
+- Ahead-of-time compilation
+- The [C and C++ Standard libraries support](https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/C-CXX-StandardLibrary/C-CXX-StandardLibrary.rst)
+- The [Device library extensions](https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/C-CXX-StandardLibrary/DeviceLibExtensions.rst)
+- Host device (in some cases)
+
+##### Unsupported standard SYCL APIs:
+- Local accessors
+- Most of image APIs
+- Specialization constants
+- Memory access through a raw pointer returned by `sycl::accessor::get_pointer()`
+
+##### Other restrictions:
+- Only Intel GPU device is supported
+- Usual and ESIMD DPC++ kernels can not co-exist in the same application in most
+  cases