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

Signed-off-by: Jiang, Zhiwei <zhiwei.jiang@intel.com>

Author: zhiweij1

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,

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,

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);

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;

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
 

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;
+}

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.

clang/test/dpct/ignore_rule/rule1.yaml

@@ -0,0 +1,4 @@
+- Rule: rule_MACRO_A
+  Kind: Macro
+  Priority: Takeover
+  In: MACRO_A

clang/test/dpct/not_ignore_rule/not_ignore_rule.h

@@ -0,0 +1,4 @@
+class Tensor {
+public:
+  bool is_cuda();
+};

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();
+}