[SYCLomatic] Add explicit cast if CUDA enum type is migrated to scoped type and the value is compared to a different type value. (#2829)

Signed-off-by: Chen, Sheng S <sheng.s.chen@intel.com>

Author: ShengchenJ

clang/lib/DPCT/ASTTraversal.cpp

@@ -93,6 +93,7 @@ void MigrationRule::emplaceTransformation(TextModification *TM) {
 // RuleLang
 REGISTER_RULE(IterationSpaceBuiltinRule, PassKind::PK_Analysis)
 REGISTER_RULE(ErrorHandlingIfStmtRule, PassKind::PK_Migration)
+REGISTER_RULE(CastScopedEnumTypeRule, PassKind::PK_Migration)
 REGISTER_RULE(ErrorHandlingHostAPIRule, PassKind::PK_Migration)
 REGISTER_RULE(AtomicFunctionRule, PassKind::PK_Migration)
 REGISTER_RULE(ZeroLengthArrayRule, PassKind::PK_Migration)

clang/lib/DPCT/RulesLang/RulesLang.cpp

@@ -4515,6 +4515,50 @@ void StreamAPICallRule::runRule(const MatchFinder::MatchResult &Result) {
   }
 }
 
+void CastScopedEnumTypeRule::registerMatcher(ast_matchers::MatchFinder &MF) {
+  MF.addMatcher(binaryOperator(isComparisonOperator()).bind("binOp"), this);
+}
+void CastScopedEnumTypeRule::runRule(
+    const ast_matchers::MatchFinder::MatchResult &Result) {
+  auto BO = getNodeAsType<BinaryOperator>(Result, "binOp");
+  if (!BO)
+    return;
+
+  // List the types don't need to explicit cast type after migration.
+  const std::unordered_set<std::string> TypeNoCast = {
+      "int", MapNames::getDpctNamespace() + "err0",
+      MapNames::getDpctNamespace() + "err1",
+      MapNames::getDpctNamespace() + "pointer_attributes"};
+
+  auto InsertEnumCast = [&](const Expr *E) {
+    const clang::EnumDecl *EnumDecl =
+        E->getType().getCanonicalType()->getAs<clang::EnumType>()->getDecl();
+
+    std::string EnumName = EnumDecl->getNameAsString();
+    std::string ReplacedName =
+        MapNames::findReplacedName(MapNames::TypeNamesMap, EnumName);
+
+    if (TypeNoCast.count(ReplacedName) || ReplacedName == EnumName ||
+        EnumName.empty() ||
+        ReplacedName.empty()) // EnumName Empty means the enum is Anonymous
+      return;
+    if (dpct::DpctGlobalInfo::isInCudaPath(EnumDecl->getLocation())) {
+      insertAroundStmt(E, "static_cast<int>(", ")");
+    }
+  };
+  auto LHSExpr = BO->getLHS()->IgnoreImpCasts();
+  auto RHSExpr = BO->getRHS()->IgnoreImpCasts();
+
+  if (LHSExpr->getType()->isEnumeralType() && !dyn_cast<CallExpr>(LHSExpr) &&
+      !RHSExpr->getType()->isEnumeralType()) {
+    InsertEnumCast(LHSExpr);
+  } else if (!LHSExpr->getType()->isEnumeralType() &&
+             RHSExpr->getType()->isEnumeralType() &&
+             !dyn_cast<CallExpr>(RHSExpr)) {
+    InsertEnumCast(RHSExpr);
+  }
+}
+
 void KernelCallRefRule::registerMatcher(ast_matchers::MatchFinder &MF) {
   MF.addMatcher(
       functionDecl(

clang/lib/DPCT/RulesLang/RulesLang.h

@@ -435,6 +435,14 @@ class StreamAPICallRule : public NamedMigrationRule<StreamAPICallRule> {
   void runRule(const ast_matchers::MatchFinder::MatchResult &Result);
 };
 
+/// Migration rule for binary operator calls
+class CastScopedEnumTypeRule
+    : public NamedMigrationRule<CastScopedEnumTypeRule> {
+public:
+  void registerMatcher(ast_matchers::MatchFinder &MF) override;
+  void runRule(const ast_matchers::MatchFinder::MatchResult &Result);
+};
+
 /// Migration rule for kernel API calls
 class KernelCallRule : public NamedMigrationRule<KernelCallRule> {
   std::unordered_set<unsigned> Insertions;

clang/test/dpct/enum_type.cu

@@ -0,0 +1,24 @@
+// RUN: dpct --format-range=none -out-root %T/enum_type %s --cuda-include-path="%cuda-path/include" -- -std=c++14 -x cuda --cuda-host-only
+// RUN: FileCheck --input-file %T/enum_type/enum_type.dp.cpp --match-full-lines %s
+// RUN: %if build_lit %{icpx -c -fsycl -DNO_BUILD_TEST  %T/enum_type/enum_type.dp.cpp -o %T/enum_type/enum_type.dp.o %}
+#include <cuda.h>
+int main() {
+  // CHECK: sycl::usm::alloc mem_type;
+  CUmemorytype mem_type;
+  // CHECK: if (static_cast<int>(mem_type) == 0)
+  if (mem_type == 0)
+    ;
+  // CHECK: if (0 == static_cast<int>(mem_type))
+  if (0 == mem_type)
+    ;
+  // CHECK: if (sycl::usm::alloc::host == mem_type)
+  if (CU_MEMORYTYPE_HOST == mem_type)
+    ;
+  // CHECK: if (0 <= static_cast<int>(mem_type))
+  if (0 <= mem_type)
+    ;
+  // CHECK: if (static_cast<int>(mem_type) > 0)
+  if (mem_type > 0)
+    ;
+  return 0;
+}