[SYCLomatic] Rename the rules folder for predefined user defined migration rule and add a README file (#2621)

Author: zhiweij1

clang/test/dpct/macro_rule.cu

@@ -1,4 +1,4 @@
-// RUN: dpct --rule-file=%S/../../tools/dpct/DpctOptRules/macro_checks.yaml --format-range=none -out-root %T/macro_rule %s --cuda-include-path="%cuda-path/include" -- -x cuda --cuda-host-only
+// RUN: dpct --rule-file=%S/../../tools/dpct/extensions/opt_rules/macro_checks.yaml --format-range=none -out-root %T/macro_rule %s --cuda-include-path="%cuda-path/include" -- -x cuda --cuda-host-only
 // RUN: FileCheck --input-file %T/macro_rule/macro_rule.dp.cpp --match-full-lines %s
 // RUN: %if build_lit %{icpx -c -fsycl %T/macro_rule/macro_rule.dp.cpp -o %T/macro_rule/macro_rule.dp.o %}
 #include <cuda_runtime.h>

clang/test/dpct/math_specific_UDR_test.cu

@@ -1,4 +1,4 @@
-// RUN: dpct --rule-file=%S/../../tools/dpct/DpctOptRules/intel_specific_math.yaml --format-range=none -out-root %T/math_specific_UDR_test %s --cuda-include-path="%cuda-path/include" -- -x cuda --cuda-host-only
+// RUN: dpct --rule-file=%S/../../tools/dpct/extensions/opt_rules/intel_specific_math.yaml --format-range=none -out-root %T/math_specific_UDR_test %s --cuda-include-path="%cuda-path/include" -- -x cuda --cuda-host-only
 // RUN: FileCheck --input-file %T/math_specific_UDR_test/math_specific_UDR_test.dp.cpp --match-full-lines %s
 // RUN: %if build_lit %{icpx -c -fsycl %T/math_specific_UDR_test/math_specific_UDR_test.dp.cpp -o %T/math_specific_UDR_test/math_specific_UDR_test.dp.o %}
 

clang/test/dpct/pytorch/ATen.cu

@@ -4,7 +4,7 @@
 // RUN: cp -r %S/pytorch_inc %T/pytorch/ATen/
 // RUN: cd %T/pytorch/ATen
 // RUN: mkdir dpct_out
-// RUN: dpct --out-root dpct_out %T/pytorch/ATen/src/ATen.cu --extra-arg="-I%T/pytorch/ATen/pytorch_inc" --cuda-include-path="%cuda-path/include" --rule-file=%S/../../../tools/dpct/DpctOptRules/pytorch_api.yaml --analysis-scope-path %T/pytorch/ATen/pytorch_inc --analysis-scope-path %T/pytorch/ATen/src --in-root %T/pytorch/ATen/src
+// RUN: dpct --out-root dpct_out %T/pytorch/ATen/src/ATen.cu --extra-arg="-I%T/pytorch/ATen/pytorch_inc" --cuda-include-path="%cuda-path/include" --rule-file=%S/../../../tools/dpct/extensions/pytorch_api_rules/pytorch_api.yaml --analysis-scope-path %T/pytorch/ATen/pytorch_inc --analysis-scope-path %T/pytorch/ATen/src --in-root %T/pytorch/ATen/src
 // RUN: FileCheck --input-file %T/pytorch/ATen/dpct_out/ATen.dp.cpp --match-full-lines %T/pytorch/ATen/src/ATen.cu
 
 // CHECK: #include <c10/xpu/XPUStream.h>

clang/test/dpct/pytorch/c10.cu

@@ -4,7 +4,7 @@
 // RUN: cp -r %S/pytorch_inc %T/pytorch/c10/
 // RUN: cd %T/pytorch/c10
 // RUN: mkdir dpct_out
-// RUN: dpct -out-root dpct_out %T/pytorch/c10/src/c10.cu --extra-arg="-I%T/pytorch/c10/pytorch_inc" --cuda-include-path="%cuda-path/include" --rule-file=%S/../../../tools/dpct/DpctOptRules/pytorch_api.yaml  -- -x cuda --cuda-host-only
+// RUN: dpct -out-root dpct_out %T/pytorch/c10/src/c10.cu --extra-arg="-I%T/pytorch/c10/pytorch_inc" --cuda-include-path="%cuda-path/include" --rule-file=%S/../../../tools/dpct/extensions/pytorch_api_rules/pytorch_api.yaml  -- -x cuda --cuda-host-only
 // RUN: FileCheck --input-file %T/pytorch/c10/dpct_out/c10.dp.cpp --match-full-lines %T/pytorch/c10/src/c10.cu
 
 #include <iostream>

clang/test/dpct/pytorch/torch.cu

@@ -4,7 +4,7 @@
 // RUN: cp -r %S/pytorch_inc %T/pytorch/torch/
 // RUN: cd %T/pytorch/torch
 // RUN: mkdir dpct_out
-// RUN: dpct --out-root dpct_out %T/pytorch/torch/src/torch.cu --extra-arg="-I%T/pytorch/torch/pytorch_inc" --cuda-include-path="%cuda-path/include" --rule-file=%S/../../../tools/dpct/DpctOptRules/pytorch_api.yaml --analysis-scope-path %T/pytorch/torch/pytorch_inc --analysis-scope-path %T/pytorch/torch/src --in-root %T/pytorch/torch/src
+// RUN: dpct --out-root dpct_out %T/pytorch/torch/src/torch.cu --extra-arg="-I%T/pytorch/torch/pytorch_inc" --cuda-include-path="%cuda-path/include" --rule-file=%S/../../../tools/dpct/extensions/pytorch_api_rules/pytorch_api.yaml --analysis-scope-path %T/pytorch/torch/pytorch_inc --analysis-scope-path %T/pytorch/torch/src --in-root %T/pytorch/torch/src
 // RUN: FileCheck --input-file %T/pytorch/torch/dpct_out/torch.dp.cpp --match-full-lines %T/pytorch/torch/src/torch.cu
 
 // CHECK: #include <c10/xpu/XPUStream.h>

clang/tools/dpct/CMakeLists.txt

@@ -61,8 +61,7 @@ if (NOT CMAKE_CONFIGURATION_TYPES)
                              COMPONENT dpct-setvars)
 endif()
 
-add_subdirectory(DpctOptRules)
-add_subdirectory(RuleTemplates)
+add_subdirectory(extensions)
 
 set(dpct_cmake_helper_file
   ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/cmake/dpct.cmake

clang/tools/dpct/DpctOptRules/CMakeLists.txt

@@ -0,0 +1,85 @@
+set(dpct_opt_rule_files
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/opt_rules/forceinline.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/opt_rules/intel_specific_math.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/opt_rules/macro_checks.yaml
+)
+
+set(dpct_cmake_rule_files
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/cmake_rules/cmake_script_migration_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/cmake_rules/cmake_script_migration_rule_optional.yaml
+)
+
+set(dpct_python_rule_files
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/python_rules/python_build_script_migration_rule_ipex.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/python_rules/python_build_script_migration_rule_pytorch.yaml
+)
+
+set(dpct_pytorch_api_rule_files
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/pytorch_api_rules/pytorch_api.yaml
+)
+
+set(dpct_rule_template_files
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/api_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/class_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/disable_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/enum_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/header_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/macro_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/pattern_rewrite_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/type_rule.yaml
+  ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/rule_templates/helper_function_rule.yaml
+)
+
+install(
+  FILES ${dpct_opt_rule_files}
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ./extensions/opt_rules)
+
+install(
+  FILES ${dpct_cmake_rule_files}
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ./extensions/cmake_rules)
+
+install(
+  FILES ${dpct_python_rule_files}
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ./extensions/python_rules)
+
+install(
+  FILES ${dpct_pytorch_api_rule_files}
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ./extensions/pytorch_api_rules)
+
+install(
+  FILES ${dpct_rule_template_files}
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ./extensions/rule_templates)
+
+install(
+  FILES ${CMAKE_SOURCE_DIR}/../clang/tools/dpct/extensions/README.md
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ./extensions)
+
+# Below two install commands are copying those files into some location under
+# the build folder, which need be accessed during the LIT.
+install(
+  FILES ${dpct_cmake_rule_files}
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ${CMAKE_BINARY_DIR}/extensions/cmake_rules)
+install(
+  FILES ${dpct_python_rule_files}
+  COMPONENT dpct-rules
+  PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
+  DESTINATION ${CMAKE_BINARY_DIR}/extensions/python_rules)
+
+if (NOT CMAKE_CONFIGURATION_TYPES) # don't add this for IDE's.
+  add_llvm_install_targets(install-dpct-rules
+                           COMPONENT dpct-rules)
+endif()

clang/tools/dpct/RuleTemplates/CMakeLists.txt

@@ -0,0 +1,28 @@
+# Pre-defined rules
+This folder provides predefined user-defined migration rules in YAML files, targeted to extend the tool's migration capability. The `rule_templates` folder provides example rules to implement a user migration rule in YAML user can refer to, while other rule folders provide migration rules that can be loaded and applied directly by the tool's option `--rule-files`.
+
+## cmake_rules
+This folder provides migration rules for CMake script.
+
+`cmake_script_migration_rule.yaml`: Provides the general migration rules for CMake script migration. This file is loaded by default if the tool is guided to migrate the CMake script (option `--migrate-build-script=CMake` is provided by the user).
+
+`cmake_script_migration_rule_optional.yaml`: Provides extra migration rules for CMake script migration. It is not loaded by default, but please apply it if necessary.
+
+## opt_rules
+This folder provides optional migration rules.  The migration rules are not loaded by default, but please apply them if necessary.
+
+`forceinline.yaml`: Provides a specific migration rule to migrate `__forceinline__` to `inline` instead of `__dpct_inline__`.
+
+`intel_specific_math.yaml`: Provides migration rules to migrate some math API to Intel(R) hardware-specific API.
+
+`macro_checks.yaml`: Provides a specific migration rule to migrate the error-checking macro `CUDA_CHECK` to `DPCT_CHECK_ERROR.`
+
+## python_rules
+This folder provides migration rules for Python script.  The migration rules are not loaded by default, but please apply them if necessary.
+
+`python_build_script_migration_rule_ipex.yaml`: provides migration rules to migrate python build script for Pytorch-based projects to work with Intel(R) Extension for PyTorch (IPEX).
+
+`python_build_script_migration_rule_pytorch.yaml`: provides migration rules to migrate Python build script for Pytorch-based projects to work with official PyTorch release with XPU support.
+
+## pytorch_api_rule_rules
+`pytorch_api.yaml`: provides migration rules to migrate Pytorch CUDA backend-specific API of Pytorch-based projects to Pytorch backend agnostic API or XPU backend-specific API.