Xu isa help (#1435)

* add isa_help module
* switch isa check to isa_help backend.
* remove cpuid dependency.

Author: xuhancn

intel_extension_for_pytorch/__init__.py

@@ -5,7 +5,8 @@
     pass  # skip if torchvision is not available
 
 from ._version import __version__
-from .utils import _cpu_isa, _custom_fx_tracer
+from .utils import _custom_fx_tracer
+from .cpu import _cpu_isa
 _cpu_isa.check_minimal_isa_support()
 
 torch_version = ''

intel_extension_for_pytorch/cpu/_cpu_isa.py

@@ -0,0 +1,10 @@
+import intel_extension_for_pytorch._isa_help as isa
+import sys
+
+def check_avx2_support():
+    return isa._check_isa_avx2()
+
+def check_minimal_isa_support():
+    err_msg = "ERROR! Intel® Extension for PyTorch* only works on machines with instruction sets equal or newer than AVX2, which are not detected on the current machine."
+    if not check_avx2_support():
+        sys.exit(err_msg)

intel_extension_for_pytorch/csrc/CMakeLists.txt

@@ -19,6 +19,7 @@ endif()
 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${PYBIND11_CL_FLAGS}")
 
 if(BUILD_WITH_CPU)
+  add_subdirectory(cpu/isa_help)
   add_subdirectory(cpu)
   list(APPEND PY_CPP_OBJS $<TARGET_OBJECTS:PY_CPU_OBJ>)
 endif()

intel_extension_for_pytorch/csrc/_isa_help_main.cpp

@@ -0,0 +1,14 @@
+#include <pybind11/pybind11.h>
+#include "cpu/isa_help/isa_help.h"
+
+namespace py = pybind11;
+
+void InitIsaHelpModuleBindings(py::module m) {
+  m.def("_check_isa_avx2", []() { return isa_help::check_isa_avx2(); });
+
+  m.def("_check_isa_avx512", []() { return isa_help::check_isa_avx512(); });
+}
+
+PYBIND11_MODULE(_isa_help, m) {
+  InitIsaHelpModuleBindings(m);
+}

intel_extension_for_pytorch/csrc/cpu/isa_help/CMakeLists.txt

@@ -0,0 +1,20 @@
+set(ISA_HELP_NAME "isa_help")
+
+# ---[ Build flags
+include(${IPEX_ROOT_DIR}/cmake/cpu/BuildFlags.cmake)
+
+set(IPEX_CPU_CPP_ISA_SRCS)
+add_subdirectory(${IPEX_CPU_ROOT_DIR}/isa ${ISA_HELP_NAME}_isa_code)
+
+# Current Directory Sources
+FILE(GLOB IPEX_ISA_HELP_SRCS *.cpp *.h)
+
+set(ISA_HELP_SRCS ${IPEX_ISA_HELP_SRCS} ${IPEX_CPU_CPP_ISA_SRCS})
+
+add_library(${ISA_HELP_NAME} ${ISA_HELP_SRCS})
+
+target_include_directories(${ISA_HELP_NAME} PUBLIC ${IPEX_CPU_ROOT_DIR}/isa)
+
+install(TARGETS ${ISA_HELP_NAME}
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})

intel_extension_for_pytorch/csrc/cpu/isa_help/isa_help.cpp

@@ -0,0 +1,15 @@
+#include "isa_help.h"
+
+#include "cpu_feature.hpp"
+#include "embedded_function.h"
+
+namespace isa_help {
+bool check_isa_avx2() {
+  return torch_ipex::cpu::CPUFeature::get_instance().os_avx2();
+}
+
+bool check_isa_avx512() {
+  return torch_ipex::cpu::CPUFeature::get_instance().os_avx512();
+}
+
+} // namespace isa_help

intel_extension_for_pytorch/csrc/cpu/isa_help/isa_help.h

@@ -0,0 +1,6 @@
+#pragma once
+
+namespace isa_help {
+bool check_isa_avx2();
+bool check_isa_avx512();
+} // namespace isa_help

intel_extension_for_pytorch/utils/_cpu_isa.py

@@ -5,4 +5,3 @@ wheel>=0.36
 setuptools>=50.0
 packaging
 psutil
-cpuid

requirements.txt

@@ -193,7 +193,6 @@ def _build_installation_dependency():
     install_requires = []
     install_requires.append('psutil')
     install_requires.append('numpy')
-    install_requires.append('cpuid')
     return install_requires
 
 
@@ -773,6 +772,50 @@ def pyi_module():
         extra_link_args=[make_relative_rpath('lib')])
     return C_ext
 
+def pyi_isa_help_module():
+    main_libraries = ['isa_help']
+    main_sources = [os.path.join(PACKAGE_NAME, "csrc", "_isa_help_main.cpp")]
+
+    include_dirs = [
+        os.path.realpath("."),
+        os.path.realpath(os.path.join(PACKAGE_NAME, "csrc")),
+        os.path.join(pytorch_install_dir, "include"),
+        os.path.join(pytorch_install_dir, "include", "torch", "csrc", "api", "include")]
+
+    library_dirs = [
+        "lib",
+        os.path.join(pytorch_install_dir, "lib")
+        ]
+
+    extra_compile_args = [
+        '-Wall',
+        '-Wextra',
+        '-Wno-strict-overflow',
+        '-Wno-unused-parameter',
+        '-Wno-missing-field-initializers',
+        '-Wno-write-strings',
+        '-Wno-unknown-pragmas',
+        # This is required for Python 2 declarations that are deprecated in 3.
+        '-Wno-deprecated-declarations',
+        # Python 2.6 requires -fno-strict-aliasing, see
+        # http://legacy.python.org/dev/peps/pep-3123/
+        # We also depend on it in our code (even Python 3).
+        '-fno-strict-aliasing',
+        # Clang has an unfixed bug leading to spurious missing
+        # braces warnings, see
+        # https://bugs.llvm.org/show_bug.cgi?id=21629
+        '-Wno-missing-braces']
+
+    C_ext = CppExtension(
+        "{}._isa_help".format(PACKAGE_NAME),
+        libraries=main_libraries,
+        sources=main_sources,
+        language='c++',
+        extra_compile_args=extra_compile_args,
+        include_dirs=include_dirs,
+        library_dirs=library_dirs,
+        extra_link_args=[make_relative_rpath('lib')])
+    return C_ext
 
 ext_modules=[]
 cmdclass = {
@@ -797,6 +840,7 @@ def run(self):
     cmdclass['egg_info'] = IPEXEggInfoBuild
     cmdclass['install'] = IPEXInstallCmd
     ext_modules.append(pyi_module())
+    ext_modules.append(pyi_isa_help_module())
 
 
 if _get_build_target() == 'python':