Symbol renaming : esimd_emu -> esimd_emulator

Author: dongkyunahn-intel

sycl/include/CL/sycl/detail/pi.hpp

@@ -65,13 +65,13 @@ bool trace(TraceLevel level);
 #define __SYCL_OPENCL_PLUGIN_NAME "pi_opencl.dll"
 #define __SYCL_LEVEL_ZERO_PLUGIN_NAME "pi_level_zero.dll"
 #define __SYCL_CUDA_PLUGIN_NAME "pi_cuda.dll"
-#define __SYCL_ESIMD_EMU_PLUGIN_NAME "pi_esimd_emu.dll"
+#define __SYCL_ESIMD_EMULATOR_PLUGIN_NAME "pi_esimd_emulator.dll"
 #define __SYCL_HIP_PLUGIN_NAME "libpi_hip.dll"
 #else
 #define __SYCL_OPENCL_PLUGIN_NAME "libpi_opencl.so"
 #define __SYCL_LEVEL_ZERO_PLUGIN_NAME "libpi_level_zero.so"
 #define __SYCL_CUDA_PLUGIN_NAME "libpi_cuda.so"
-#define __SYCL_ESIMD_EMU_PLUGIN_NAME "libpi_esimd_emu.so"
+#define __SYCL_ESIMD_EMULATOR_PLUGIN_NAME "libpi_esimd_emulator.so"
 #define __SYCL_HIP_PLUGIN_NAME "libpi_hip.so"
 #endif
 

sycl/include/sycl/ext/intel/experimental/esimd/emu/detail/esimd_emulator_device_interface.hpp

@@ -1,4 +1,4 @@
-//==----- esimdemu_device_interface.hpp - DPC++ Explicit SIMD API ----------==//
+//==----- esimd_emulator_device_interface.hpp - DPC++ Explicit SIMD API ----------==//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -7,21 +7,21 @@
 //===----------------------------------------------------------------------===//
 
 /// \file esimdemu_device_interface.hpp
-/// Declarations for ESIMD_EMU-device specific definitions.
+/// Declarations for ESIMD_EMULATOR-device specific definitions.
 /// ESIMD intrinsic and LibCM functionalities required by intrinsic defined
 ///
 /// This interface is for ESIMD intrinsic emulation implementations
-/// such as slm_access to access ESIMD_EMU specific-support therefore
+/// such as slm_access to access ESIMD_EMULATOR specific-support therefore
 /// it has to be defined and shared as include directory
 ///
-/// \ingroup sycl_pi_esimd_emu
+/// \ingroup sycl_pi_esimd_emulator
 
 #pragma once
 
 #include <CL/sycl/detail/pi.hpp>
 
 // cstdint-type fields such as 'uint32_t' are to be used in funtion
-// pointer table file ('esimd_emu_functions_v1.h') included in 'struct
+// pointer table file ('esimd_emulator_functions_v1.h') included in 'struct
 // ESIMDDeviceInterface' definition.
 #include <cstdint>
 #include <mutex>
@@ -35,7 +35,7 @@ namespace detail {
 #define ESIMD_DEVICE_INTERFACE_VERSION 1
 
 // 'ESIMDDeviceInterface' structure defines interface for ESIMD CPU
-// emulation (ESIMD_EMU) to access LibCM CPU emulation functionalities
+// emulation (ESIMD_EMULATOR) to access LibCM CPU emulation functionalities
 // from kernel application under emulation.
 
 // Header files included in the structure contains only function
@@ -51,13 +51,13 @@ struct ESIMDDeviceInterface {
   void *reserved;
 
   ESIMDDeviceInterface();
-#include "esimd_emu_functions_v1.h"
+#include "esimd_emulator_functions_v1.h"
 };
 
 // Denotes the data version used by the implementation.
 // Increment whenever the 'data' field interpretation within PluginOpaqueData is
 // changed.
-#define ESIMD_EMU_PLUGIN_OPAQUE_DATA_VERSION 0
+#define ESIMD_EMULATOR_PLUGIN_OPAQUE_DATA_VERSION 0
 /// This structure denotes a ESIMD EMU plugin-specific data returned via the
 /// piextPluginGetOpaqueData PI call. Depending on the \c version field, the
 /// second \c data field can be interpreted differently.
@@ -76,14 +76,14 @@ ESIMDDeviceInterface *getESIMDDeviceInterface() {
   void *PIOpaqueData = nullptr;
 
   PIOpaqueData =
-      getPluginOpaqueData<cl::sycl::backend::ext_oneapi_esimd_emulator>(
+      getPluginOpaqueData<cl::sycl::backend::ext_intel_esimd_emulator>(
           nullptr);
 
   ESIMDEmuPluginOpaqueData *OpaqueData =
       reinterpret_cast<ESIMDEmuPluginOpaqueData *>(PIOpaqueData);
 
   // First check if opaque data version is compatible.
-  if (OpaqueData->version != ESIMD_EMU_PLUGIN_OPAQUE_DATA_VERSION) {
+  if (OpaqueData->version != ESIMD_EMULATOR_PLUGIN_OPAQUE_DATA_VERSION) {
     // NOTE: the version check should always be '!=' as layouts of different
     // versions of PluginOpaqueData is not backward compatible, unlike
     // layout of the ESIMDDeviceInterface.
@@ -92,7 +92,7 @@ ESIMDDeviceInterface *getESIMDDeviceInterface() {
               << "Opaque data returned by ESIMD Emu plugin is incompatible with"
               << "the one used in current implementation." << std::endl
               << "Returned version : " << OpaqueData->version << std::endl
-              << "Required version : " << ESIMD_EMU_PLUGIN_OPAQUE_DATA_VERSION
+              << "Required version : " << ESIMD_EMULATOR_PLUGIN_OPAQUE_DATA_VERSION
               << std::endl;
     throw cl::sycl::feature_not_supported();
   }
@@ -115,7 +115,7 @@ ESIMDDeviceInterface *getESIMDDeviceInterface() {
 }
 
 #undef ESIMD_DEVICE_INTERFACE_VERSION
-#undef ESIMD_EMU_PLUGIN_OPAQUE_DATA_VERSION
+#undef ESIMD_EMULATOR_PLUGIN_OPAQUE_DATA_VERSION
 
 } // namespace detail
 } // namespace sycl

sycl/include/sycl/ext/intel/experimental/esimd/emu/detail/esimd_emulator_functions_v1.h

@@ -1,14 +1,14 @@
-//==----- esimd_emu_functions_v1.h - DPC++ Explicit SIMD API ---------==//
+//==----- esimd_emulator_functions_v1.h - DPC++ Explicit SIMD API ---------==//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
-/// \file esimd_emu_functions_v1.h
+/// \file esimd_emulator_functions_v1.h
 ///
-/// \ingroup sycl_pi_esimd_emu
+/// \ingroup sycl_pi_esimd_emulator
 
 #pragma once
 

sycl/plugins/esimd_emulator/CMakeLists.txt

@@ -1,11 +1,11 @@
 
 # PI Esimd CPU  library
-# Create Shared library for libpi_esimd_emu.so.
+# Create Shared library for libpi_esimd_emulator.so.
 
 include(ExternalProject)
 
 include_directories("${sycl_inc_dir}")
-# FIXME/TODO: 'pi.h' is included in 'pi_esimd_emu.cpp', and CL_*_INTEL
+# FIXME/TODO: 'pi.h' is included in 'pi_esimd_emulator.cpp', and CL_*_INTEL
 # and CL_*_KHR definitions in 'pi.h' are from
 # ${OPENCL_INCLUDE}. Remove build dependency on OpenCL
 include_directories(${OpenCL_INCLUDE_DIR})
@@ -14,11 +14,11 @@ file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/cm-emu_build)
 file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/cm-emu_install)
 
 if (MSVC)
-  set(LIBCM ${LLVM_BINARY_DIR}/pi_esimd_emu_deps/lib/libcm${CMAKE_STATIC_LIBRARY_SUFFIX})
-  set(LIBIGFXCMRT_EMU ${LLVM_BINARY_DIR}/pi_esimd_emu_deps/lib/igfxcmrt64_emu${CMAKE_STATIC_LIBRARY_SUFFIX})
+  set(LIBCM ${LLVM_BINARY_DIR}/pi_esimd_emulator_deps/lib/libcm${CMAKE_STATIC_LIBRARY_SUFFIX})
+  set(LIBIGFXCMRT_EMU ${LLVM_BINARY_DIR}/pi_esimd_emulator_deps/lib/igfxcmrt64_emu${CMAKE_STATIC_LIBRARY_SUFFIX})
 else()
-  set(LIBCM ${LLVM_BINARY_DIR}/pi_esimd_emu_deps/lib/libcm${CMAKE_SHARED_LIBRARY_SUFFIX})
-  set(LIBIGFXCMRT_EMU ${LLVM_BINARY_DIR}/pi_esimd_emu_deps/lib/libigfxcmrt_emu${CMAKE_SHARED_LIBRARY_SUFFIX})
+  set(LIBCM ${LLVM_BINARY_DIR}/pi_esimd_emulator_deps/lib/libcm${CMAKE_SHARED_LIBRARY_SUFFIX})
+  set(LIBIGFXCMRT_EMU ${LLVM_BINARY_DIR}/pi_esimd_emulator_deps/lib/libigfxcmrt_emu${CMAKE_SHARED_LIBRARY_SUFFIX})
 endif()
 
 if (DEFINED CM_LOCAL_SOURCE_DIR)
@@ -75,13 +75,13 @@ else ()
   endif()
 endif ()
 ExternalProject_Add_Step(cm-emu llvminstall
-  COMMAND ${CMAKE_COMMAND} -E make_directory ${LLVM_BINARY_DIR}/pi_esimd_emu_deps && ${CMAKE_COMMAND} -E copy_directory <INSTALL_DIR>/ ${LLVM_BINARY_DIR}/pi_esimd_emu_deps
+  COMMAND ${CMAKE_COMMAND} -E make_directory ${LLVM_BINARY_DIR}/pi_esimd_emulator_deps && ${CMAKE_COMMAND} -E copy_directory <INSTALL_DIR>/ ${LLVM_BINARY_DIR}/pi_esimd_emulator_deps
   COMMENT "Installing cm-emu into the LLVM binary directory"
   DEPENDEES install
 )
 
-include_directories(${LLVM_BINARY_DIR}/pi_esimd_emu_deps/include/igfxcmrt_emu)
-include_directories(${LLVM_BINARY_DIR}/pi_esimd_emu_deps/include/libcm/cm)
+include_directories(${LLVM_BINARY_DIR}/pi_esimd_emulator_deps/include/igfxcmrt_emu)
+include_directories(${LLVM_BINARY_DIR}/pi_esimd_emulator_deps/include/libcm/cm)
 
 # Compilation flag to exclude lines in header files imported from CM
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D__SYCL_EXPLICIT_SIMD_PLUGIN__")
@@ -96,43 +96,43 @@ else()
 string(REPLACE "-pedantic" " " CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
 endif()
 
-add_library(pi_esimd_emu SHARED
+add_library(pi_esimd_emulator SHARED
   "${sycl_inc_dir}/CL/sycl/detail/pi.h"
-  "pi_esimd_emu.cpp"
+  "pi_esimd_emulator.cpp"
 )
 
 if (MSVC)
   # by defining __SYCL_BUILD_SYCL_DLL, we can use __declspec(dllexport)
   # which are individually tagged for all pi* symbols in pi.h
-  target_compile_definitions(pi_esimd_emu PRIVATE __SYCL_BUILD_SYCL_DLL)
+  target_compile_definitions(pi_esimd_emulator PRIVATE __SYCL_BUILD_SYCL_DLL)
 else()
   # we set the visibility of all symbols 'hidden' by default.
   # In pi.h file, we set exported symbols with visibility==default individually
-  target_compile_options(pi_esimd_emu PUBLIC -fvisibility=hidden)
+  target_compile_options(pi_esimd_emulator PUBLIC -fvisibility=hidden)
 
   # This script file is used to allow exporting pi* symbols only.
   # All other symbols are regarded as local (hidden)
   set(linker_script "${CMAKE_CURRENT_SOURCE_DIR}/../ld-version-script.txt")
 
   # Filter symbols based on the scope defined in the script file,
   # and export pi* function symbols in the library.
-  target_link_libraries( pi_esimd_emu
+  target_link_libraries( pi_esimd_emulator
     PRIVATE "-Wl,--version-script=${linker_script}"
   )
 endif()
 
-add_dependencies(pi_esimd_emu OpenCL-Headers)
-add_dependencies(pi_esimd_emu cm-emu)
-add_dependencies(sycl-toolchain pi_esimd_emu)
+add_dependencies(pi_esimd_emulator OpenCL-Headers)
+add_dependencies(pi_esimd_emulator cm-emu)
+add_dependencies(sycl-toolchain pi_esimd_emulator)
 
-target_link_libraries(pi_esimd_emu PRIVATE sycl ${LIBCM} ${LIBIGFXCMRT_EMU})
-set_target_properties(pi_esimd_emu PROPERTIES LINKER_LANGUAGE CXX)
+target_link_libraries(pi_esimd_emulator PRIVATE sycl ${LIBCM} ${LIBIGFXCMRT_EMU})
+set_target_properties(pi_esimd_emulator PROPERTIES LINKER_LANGUAGE CXX)
 
-add_common_options(pi_esimd_emu)
+add_common_options(pi_esimd_emulator)
 
-install(TARGETS pi_esimd_emu
-        LIBRARY DESTINATION "lib${LLVM_LIBDIR_SUFFIX}" COMPONENT pi_esimd_emu
-        RUNTIME DESTINATION "bin" COMPONENT pi_esimd_emu)
+install(TARGETS pi_esimd_emulator
+        LIBRARY DESTINATION "lib${LLVM_LIBDIR_SUFFIX}" COMPONENT pi_esimd_emulator
+        RUNTIME DESTINATION "bin" COMPONENT pi_esimd_emulator)
 
 # Copy CM Header files to $(INSTALL)/include/sycl/CL/
 install(DIRECTORY    ${CMAKE_CURRENT_BINARY_DIR}/cm-emu_install/include/libcm/cm/

sycl/plugins/esimd_emulator/pi_esimd_emulator.cpp

@@ -1,16 +1,16 @@
-//===---------- pi_esimd_emu.cpp - CM Emulation Plugin --------------------===//
+//===---------- pi_esimd_emulator.cpp - CM Emulation Plugin ---------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
-/// \file pi_esimd_emu.cpp
+/// \file pi_esimd_emulator.cpp
 /// Declarations for CM Emulation Plugin. It is the interface between the
 /// device-agnostic SYCL runtime layer and underlying CM Emulation
 ///
-/// \ingroup sycl_pi_esimd_emu
+/// \ingroup sycl_pi_esimd_emulator
 
 #include <stdint.h>
 
@@ -40,7 +40,7 @@
 #include <thread>
 #include <utility>
 
-#include "pi_esimd_emu.hpp"
+#include "pi_esimd_emulator.hpp"
 
 namespace {
 
@@ -108,14 +108,14 @@ class ReturnHelper {
 // Controls PI level tracing prints.
 static bool PrintPiTrace = false;
 
-// Global variables used in PI_esimd_emu
+// Global variables used in PI_esimd_emulator
 // Note we only create a simple pointer variables such that C++ RT won't
 // deallocate them automatically at the end of the main program.
 // The heap memory allocated for this global variable reclaimed only when
 // Sycl RT calls piTearDown().
 static sycl::detail::ESIMDEmuPluginOpaqueData *PiESimdDeviceAccess;
 
-// To be compared with ESIMD_EMU_PLUGIN_OPAQUE_DATA_VERSION in device
+// To be compared with ESIMD_EMULATOR_PLUGIN_OPAQUE_DATA_VERSION in device
 // interface header file
 #define ESIMDEmuPluginDataVersion 0
 
@@ -276,13 +276,13 @@ void sycl_get_cm_image_params(void *PtrInput, char **BaseAddr, uint32_t *Width,
   *MtxLock = &(Img->mutexLock);
 }
 
-/// Implementation for ESIMD_EMU device interface accessing ESIMD
+/// Implementation for ESIMD_EMULATOR device interface accessing ESIMD
 /// intrinsics and LibCM functionalties requred by intrinsics
 sycl::detail::ESIMDDeviceInterface::ESIMDDeviceInterface() {
   version = ESIMDEmuPluginInterfaceVersion;
   reserved = nullptr;
 
-  /* From 'esimd_emu_functions_v1.h' : Start */
+  /* From 'esimd_emulator_functions_v1.h' : Start */
   cm_barrier_ptr = cm_support::barrier;
   cm_sbarrier_ptr = cm_support::split_barrier;
   cm_fence_ptr = cm_support::fence;
@@ -293,7 +293,7 @@ sycl::detail::ESIMDDeviceInterface::ESIMDDeviceInterface() {
 
   sycl_get_cm_buffer_params_ptr = sycl_get_cm_buffer_params;
   sycl_get_cm_image_params_ptr = sycl_get_cm_image_params;
-  /* From 'esimd_emu_functions_v1.h' : End */
+  /* From 'esimd_emulator_functions_v1.h' : End */
 }
 
 /// Implementation for Host Kernel Launch used by
@@ -392,7 +392,7 @@ pi_result piPlatformGetInfo(pi_platform Platform, pi_platform_info ParamName,
 
   switch (ParamName) {
   case PI_PLATFORM_INFO_NAME:
-    return ReturnValue("Intel(R) ESIMD_EMU/GPU");
+    return ReturnValue("Intel(R) ESIMD_EMULATOR/GPU");
 
   case PI_PLATFORM_INFO_VENDOR:
     return ReturnValue("Intel(R) Corporation");
@@ -495,7 +495,7 @@ pi_result piDeviceGetInfo(pi_device Device, pi_device_info ParamName,
   case PI_DEVICE_INFO_PLATFORM:
     return ReturnValue(Device->Platform);
   case PI_DEVICE_INFO_NAME:
-    return ReturnValue("ESIMD_EMU");
+    return ReturnValue("ESIMD_EMULATOR");
   case PI_DEVICE_INFO_IMAGE_SUPPORT:
     return ReturnValue(pi_bool{true});
   case PI_DEVICE_INFO_DRIVER_VERSION:
@@ -517,8 +517,8 @@ pi_result piDeviceGetInfo(pi_device Device, pi_device_info ParamName,
 #define UNSUPPORTED_INFO(info)                                                 \
   case info:                                                                   \
     std::cerr << std::endl                                                     \
-              << "Unsupported device info = " << #info << " from ESIMD_EMU"    \
-              << std::endl;                                                    \
+              << "Unsupported device info = " << #info                         \
+              << " from ESIMD_EMULATOR" << std::endl;                          \
     DIE_NO_IMPLEMENTATION;                                                     \
     break;
 
@@ -740,7 +740,7 @@ pi_result piQueueRelease(pi_queue Queue) {
 }
 
 pi_result piQueueFinish(pi_queue) {
-  // No-op as enqueued commands with ESIMD_EMU plugin are blocking
+  // No-op as enqueued commands with ESIMD_EMULATOR plugin are blocking
   // ones that do not return until their completion - kernel execution
   // and memory read.
   CONTINUE_NO_IMPLEMENTATION;
@@ -1078,7 +1078,7 @@ pi_result piEventGetProfilingInfo(pi_event Event, pi_profiling_info ParamName,
                                   size_t ParamValueSize, void *ParamValue,
                                   size_t *ParamValueSizeRet) {
   if (PrintPiTrace) {
-    std::cerr << "Warning : Profiling Not supported under PI_ESIMD_EMU"
+    std::cerr << "Warning : Profiling Not supported under PI_ESIMD_EMULATOR"
               << std::endl;
   }
   return PI_SUCCESS;
@@ -1181,7 +1181,7 @@ pi_result piEnqueueMemBufferRead(pi_queue Queue, pi_mem Src,
   /// TODO : Support Blocked read, 'Queue' handling
   if (BlockingRead) {
     assert(false &&
-           "ESIMD_EMU support for blocking piEnqueueMemBufferRead is NYI");
+           "ESIMD_EMULATOR support for blocking piEnqueueMemBufferRead is NYI");
   }
   if (NumEventsInWaitList != 0) {
     return PI_INVALID_EVENT_WAIT_LIST;
@@ -1277,7 +1277,7 @@ pi_result piEnqueueMemImageRead(pi_queue CommandQueue, pi_mem Image,
                                 pi_event *Event) {
   /// TODO : Support Blocked read, 'Queue' handling
   if (BlockingRead) {
-    assert(false && "ESIMD_EMU does not support Blocking Read");
+    assert(false && "ESIMD_EMULATOR does not support Blocking Read");
   }
   _pi_image *PiImg = static_cast<_pi_image *>(Image);
 
@@ -1508,8 +1508,9 @@ pi_result piextDeviceSelectBinary(pi_device, pi_device_binary *,
   /// for the images
   if (RawImgSize != 1) {
     if (PrintPiTrace) {
-      std::cerr << "Only single device binary image is supported in ESIMD_EMU"
-                << std::endl;
+      std::cerr
+          << "Only single device binary image is supported in ESIMD_EMULATOR"
+          << std::endl;
     }
     return PI_INVALID_VALUE;
   }
@@ -1547,8 +1548,8 @@ pi_result piPluginInit(pi_plugin *PluginInit) {
   strncpy(PluginInit->PluginVersion, _PI_H_VERSION_STRING, PluginVersionSize);
 
   PiESimdDeviceAccess = new sycl::detail::ESIMDEmuPluginOpaqueData();
-  // 'version' to be compared with 'ESIMD_EMU_DEVICE_REQUIRED_VER' defined in
-  // device interface file
+  // 'version' to be compared with 'ESIMD_EMULATOR_DEVICE_REQUIRED_VER' defined
+  // in device interface file
   PiESimdDeviceAccess->version = ESIMDEmuPluginDataVersion;
   PiESimdDeviceAccess->data =
       reinterpret_cast<void *>(new sycl::detail::ESIMDDeviceInterface());