[SYCLomatic] Ignore a YMAL rule and Emit warning if Out field is required but not specified (#2766)

zhiweij1 · web-flow · commit 950c271652bb · 2025-04-10T15:07:07.000+08:00
Signed-off-by: Jiang, Zhiwei &lt;zhiwei.jiang@intel.com&gt;
diff --git a/clang/lib/DPCT/MigrateScript/MigrateCmakeScript.cpp b/clang/lib/DPCT/MigrateScript/MigrateCmakeScript.cpp
@@ -599,7 +599,7 @@ void doCmakeScriptMigration(const clang::tooling::UnifiedPath &InRoot,
 }
 
 void registerCmakeMigrationRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   auto PR = MetaRuleObject::PatternRewriter(R.In, R.Out.value(), R.Subrules,
                                             R.MatchMode, R.Warning, R.RuleId,
diff --git a/clang/lib/DPCT/MigrateScript/MigratePythonBuildScript.cpp b/clang/lib/DPCT/MigrateScript/MigratePythonBuildScript.cpp
@@ -91,7 +91,7 @@ void doPythonBuildScriptMigration(const clang::tooling::UnifiedPath &InRoot,
 }
 
 void registerPythonMigrationRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   auto PR = MetaRuleObject::PatternRewriter(R.In, R.Out.value(), R.Subrules,
                                             R.MatchMode, R.Warning, R.RuleId,
diff --git a/clang/lib/DPCT/RulesInclude/InclusionHeaders.cpp b/clang/lib/DPCT/RulesInclude/InclusionHeaders.cpp
@@ -55,7 +55,7 @@ getUserDefinedHeader(const std::string &FileName) {
     for (auto &Header : Rule.Includes) {
       PrintHeader(Header);
     }
-    if (Rule.Out.has_value() && !Rule.Out.value().empty())
+    if (validateOutFieldAndWarn(Rule) && !Rule.Out.value().empty())
       PrintHeader(Rule.Out.value());
     OS << Rule.Postfix;
     return std::make_pair(ReplHeaderStr, Rule.Priority);
diff --git a/clang/lib/DPCT/UserDefinedRules/UserDefinedRules.cpp b/clang/lib/DPCT/UserDefinedRules/UserDefinedRules.cpp
@@ -48,7 +48,7 @@ void registerMigrationRule(const std::string &Name, Functor &&F) {
 }
 
 void registerMacroRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   auto It = MapNames::MacroRuleMap.find(R.In);
   if (It != MapNames::MacroRuleMap.end()) {
@@ -70,7 +70,7 @@ void registerMacroRule(MetaRuleObject &R) {
 }
 
 void registerAPIRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   using namespace clang::dpct;
   // register rule
@@ -122,7 +122,7 @@ void registerAPIRule(MetaRuleObject &R) {
 }
 
 void registerHeaderRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   auto It = MapNames::HeaderRuleMap.find(R.In);
   if (It != MapNames::HeaderRuleMap.end()) {
@@ -135,7 +135,7 @@ void registerHeaderRule(MetaRuleObject &R) {
 }
 
 void registerTypeRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   std::shared_ptr TOB = std::make_shared<TypeOutputBuilder>();
   TOB->Kind = TypeOutputBuilder::Kind::Top;
@@ -185,6 +185,9 @@ void registerClassRule(MetaRuleObject &R) {
   // register class name migration rule
   if (R.Out.has_value())
     registerTypeRule(R);
+  if (R.Fields.empty() && R.Methods.empty()) {
+    (void)validateOutFieldAndWarn(R);
+  }
   // register all field rules
   for (auto ItField = R.Fields.begin(); ItField != R.Fields.end(); ItField++) {
     std::string BaseAndFieldName = R.In + "." + (*ItField)->In;
@@ -258,7 +261,7 @@ void registerClassRule(MetaRuleObject &R) {
 }
 
 void registerEnumRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   auto It = MapNames::EnumNamesMap.find(R.In);
   if (It != MapNames::EnumNamesMap.end()) {
@@ -287,22 +290,22 @@ void registerEnumRule(MetaRuleObject &R) {
 }
 
 void deregisterAPIRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   using namespace clang::dpct;
   CallExprRewriterFactoryBase::RewriterMap->erase(R.In);
 }
 
 void registerPatternRewriterRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   MapNames::PatternRewriters.emplace_back(MetaRuleObject::PatternRewriter(
       R.In, R.Out.value(), R.Subrules, R.MatchMode, R.Warning, R.RuleId,
       R.BuildScriptSyntax, R.Priority));
 }
 
 void registerHelperFunctionRule(MetaRuleObject &R) {
-  if (!R.Out.has_value())
+  if (!validateOutFieldAndWarn(R))
     return;
   static const std::unordered_map<std::string, dpct::HelperFuncCatalog>
       String2HelperFuncCatalogMap{
@@ -562,6 +565,14 @@ void importRules(std::vector<clang::tooling::UnifiedPath> &RuleFiles) {
   }
 }
 
+bool validateOutFieldAndWarn(const MetaRuleObject &R) {
+  if (R.Out.has_value())
+    return true;
+  llvm::errs() << "warning: The \"Out\" field of rule " << R.RuleId << " (in "
+               << R.RuleFile << ") is not specified. This rule is ignored.\n";
+  return false;
+}
+
 // /RuleOutputString is the string specified in rule's "Out" session
 void OutputBuilder::parse(std::string &RuleOutputString) {
   size_t i, StrStartIdx = 0;
diff --git a/clang/lib/DPCT/UserDefinedRules/UserDefinedRules.h b/clang/lib/DPCT/UserDefinedRules/UserDefinedRules.h
@@ -236,6 +236,8 @@ class TypeOutputBuilder : public OutputBuilder {
 
 void importRules(std::vector<clang::tooling::UnifiedPath> &RuleFiles);
 
+bool validateOutFieldAndWarn(const MetaRuleObject &R);
+
 } // namespace dpct
 } // namespace clang
 
diff --git a/clang/test/dpct/ignore_rule/ignore_rule.cu b/clang/test/dpct/ignore_rule/ignore_rule.cu
@@ -0,0 +1,15 @@
+// RUN: dpct --out-root %T %s --cuda-include-path="%cuda-path/include" --rule-file %S/rule1.yaml 2>&1 | tee %T/output1.txt
+// RUN: FileCheck --input-file %T/ignore_rule.dp.cpp --match-full-lines %s
+// RUN: FileCheck --input-file %T/output1.txt --match-full-lines %S/output1_ref.txt
+// RUN: %if build_lit %{icpx -c -fsycl %T/ignore_rule.dp.cpp -o %T/ignore_rule.dp.o %}
+
+// CHECK: #define MACRO_A 1
+// CHECK-NEXT: void foo() {
+// CHECK-NEXT:   sycl::int2 a;
+// CHECK-NEXT:   a.x() = MACRO_A;
+// CHECK-NEXT: }
+#define MACRO_A 1
+void foo() {
+  int2 a;
+  a.x = MACRO_A;
+}
diff --git a/clang/test/dpct/ignore_rule/output1_ref.txt b/clang/test/dpct/ignore_rule/output1_ref.txt
@@ -0,0 +1 @@
+// CHECK: warning: The "Out" field of rule rule_MACRO_A (in {{.*}}rule1.yaml) is not specified. This rule is ignored.
diff --git a/clang/test/dpct/ignore_rule/rule1.yaml b/clang/test/dpct/ignore_rule/rule1.yaml
@@ -0,0 +1,4 @@
+- Rule: rule_MACRO_A
+  Kind: Macro
+  Priority: Takeover
+  In: MACRO_A
diff --git a/clang/test/dpct/not_ignore_rule/not_ignore_rule.h b/clang/test/dpct/not_ignore_rule/not_ignore_rule.h
@@ -0,0 +1,4 @@
+class Tensor {
+public:
+  bool is_cuda();
+};
diff --git a/clang/test/dpct/not_ignore_rule/src/not_ignore_rule.cu b/clang/test/dpct/not_ignore_rule/src/not_ignore_rule.cu
@@ -0,0 +1,12 @@
+// RUN: dpct --out-root %T %s --cuda-include-path="%cuda-path/include" --rule-file %S/rule2.yaml 2>&1 | tee %T/output2.txt
+// RUN: FileCheck --input-file %T/not_ignore_rule.dp.cpp --match-full-lines %s
+// RUN: FileCheck --input-file %T/output2.txt --match-full-lines %S/output2_ref.txt
+
+#include "../not_ignore_rule.h"
+
+// CHECK: void foo(Tensor a) {
+// CHECK-NEXT:   a.is_xpu();
+// CHECK-NEXT: }
+void foo(Tensor a) {
+  a.is_cuda();
+}
diff --git a/clang/test/dpct/not_ignore_rule/src/output2_ref.txt b/clang/test/dpct/not_ignore_rule/src/output2_ref.txt
@@ -0,0 +1 @@
+// CHECK-NOT: warning: The "Out" field of rule rule_Tensor (in {{.*}}rule2.yaml) is not specified. This rule is ignored.
diff --git a/clang/test/dpct/not_ignore_rule/src/rule2.yaml b/clang/test/dpct/not_ignore_rule/src/rule2.yaml
@@ -0,0 +1,7 @@
+- Rule: rule_Tensor
+  Kind: Class
+  Priority: Takeover
+  In: Tensor
+  Methods:
+    - In: is_cuda
+      Out: $method_base is_xpu()
diff --git a/clang/tools/dpct/extensions/cmake_rules/cmake_script_migration_rule.yaml b/clang/tools/dpct/extensions/cmake_rules/cmake_script_migration_rule.yaml
diff --git a/clang/tools/dpct/extensions/pytorch_api_rules/pytorch_api.yaml b/clang/tools/dpct/extensions/pytorch_api_rules/pytorch_api.yaml

Original file line number	Diff line number	Diff line change
`@@ -599,7 +599,7 @@ void doCmakeScriptMigration(const clang::tooling::UnifiedPath &InRoot,`
`599`	`599`	`}`
`600`	`600`
`601`	`601`	`void registerCmakeMigrationRule(MetaRuleObject &R) {`
`602`		`- if (!R.Out.has_value())`
	`602`	`+ if (!validateOutFieldAndWarn(R))`
`603`	`603`	`return;`
`604`	`604`	`auto PR = MetaRuleObject::PatternRewriter(R.In, R.Out.value(), R.Subrules,`
`605`	`605`	`R.MatchMode, R.Warning, R.RuleId,`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ void doPythonBuildScriptMigration(const clang::tooling::UnifiedPath &InRoot,`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`void registerPythonMigrationRule(MetaRuleObject &R) {`
`94`		`- if (!R.Out.has_value())`
	`94`	`+ if (!validateOutFieldAndWarn(R))`
`95`	`95`	`return;`
`96`	`96`	`auto PR = MetaRuleObject::PatternRewriter(R.In, R.Out.value(), R.Subrules,`
`97`	`97`	`R.MatchMode, R.Warning, R.RuleId,`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ getUserDefinedHeader(const std::string &FileName) {`
`55`	`55`	`for (auto &Header : Rule.Includes) {`
`56`	`56`	`PrintHeader(Header);`
`57`	`57`	`}`
`58`		`- if (Rule.Out.has_value() && !Rule.Out.value().empty())`
	`58`	`+ if (validateOutFieldAndWarn(Rule) && !Rule.Out.value().empty())`
`59`	`59`	`PrintHeader(Rule.Out.value());`
`60`	`60`	`OS << Rule.Postfix;`
`61`	`61`	`return std::make_pair(ReplHeaderStr, Rule.Priority);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+// CHECK: warning: The "Out" field of rule rule_MACRO_A (in {{.*}}rule1.yaml) is not specified. This rule is ignored.`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +class Tensor {
 +public:
 +  bool is_cuda();
 +};