[SYCLomatic] Enable analysis mode to summary the migration effect required with option "--analysis-mode" (#1443)

ziranzha · web-flow · commit 7dd458d2ffa4 · 2024-01-05T11:55:19.000+08:00
Signed-off-by: Ziran Zhang &lt;ziran.zhang@intel.com&gt;
diff --git a/clang/include/clang/DPCT/DPCTOptions.inc b/clang/include/clang/DPCT/DPCTOptions.inc
@@ -477,4 +477,9 @@ DPCT_ENUM_OPTION(
     llvm::cl::CommaSeparated, llvm::cl::value_desc("value"),
     llvm::cl::cat(DPCTCat), llvm::cl::ZeroOrMore)
 
+DPCT_NON_ENUM_OPTION(
+    DPCT_OPT_TYPE(static llvm::cl::opt<bool>), AnalysisMode, "analysis-mode",
+    llvm::cl::desc("Only generate report for porting effort. Default: off."),
+    llvm::cl::cat(DPCTCat), llvm::cl::init(false))
+
 #endif // !DPCT_OPTIONS_IN_CLANG_DPCT
diff --git a/clang/lib/DPCT/ASTTraversal.cpp b/clang/lib/DPCT/ASTTraversal.cpp
@@ -12483,6 +12483,7 @@ void RecognizeAPINameRule::processFuncCall(const CallExpr *CE) {
       return;
   }
 
+  recordRecognizedAPI(CE);
   auto *NSD = dyn_cast<NamespaceDecl>(ND->getDeclContext());
   Namespace = getNameSpace(NSD);
   APIName = CE->getCalleeDecl()->getAsFunction()->getNameAsString();
@@ -12526,6 +12527,7 @@ void RecognizeTypeRule::registerMatcher(ast_matchers::MatchFinder &MF) {
   auto TypeTable = MigrationStatistics::GetTypeTable();
   std::vector<std::string> UnsupportedType;
   std::vector<std::string> UnsupportedPointerType;
+  std::vector<std::string> AllTypes;
   for (auto &Type : TypeTable) {
     if (!Type.second) {
       if (Type.first.find("*") != std::string::npos) {
@@ -12535,6 +12537,9 @@ void RecognizeTypeRule::registerMatcher(ast_matchers::MatchFinder &MF) {
         UnsupportedType.push_back(Type.first);
       }
     }
+    if (DpctGlobalInfo::isAnalysisModeEnabled()) {
+      AllTypes.push_back(Type.first);
+    }
   }
   MF.addMatcher(
       typeLoc(
@@ -12544,31 +12549,42 @@ void RecognizeTypeRule::registerMatcher(ast_matchers::MatchFinder &MF) {
                 loc(pointerType(pointee(qualType(hasDeclaration(namedDecl(
                     internal::Matcher<NamedDecl>(new internal::HasNameMatcher(
                         UnsupportedPointerType))))))))))
-          .bind("typeloc"),
+          .bind("unsupportedtypeloc"),
       this);
+
+  if (DpctGlobalInfo::isAnalysisModeEnabled()) {
+    MF.addMatcher(typeLoc(loc(qualType(hasDeclaration(
+                              namedDecl(internal::Matcher<NamedDecl>(
+                                  new internal::HasNameMatcher(AllTypes)))))))
+                      .bind("alltypeloc"),
+                  this);
+  }
 }
 
 void RecognizeTypeRule::runRule(
     const ast_matchers::MatchFinder::MatchResult &Result) {
-  const TypeLoc *TL = getNodeAsType<TypeLoc>(Result, "typeloc");
-  if (!TL)
-    return;
-  auto &Context = DpctGlobalInfo::getContext();
-  QualType QTy = TL->getType();
-  if (QTy.isCanonical())
-    return;
-  std::string TypeName =
+  if (const TypeLoc* TL = getNodeAsType<TypeLoc>(Result, "unsupportedtypeloc")) {
+    auto& Context = DpctGlobalInfo::getContext();
+    QualType QTy = TL->getType();
+    if (QTy.isCanonical())
+      return;
+    std::string TypeName =
       DpctGlobalInfo::getTypeName(QTy.getUnqualifiedType(), Context);
-  // process pointer type
-  if (!QTy->isTypedefNameType() && QTy->isPointerType()) {
-    std::string PointeeTy = DpctGlobalInfo::getTypeName(
+    // process pointer type
+    if (!QTy->isTypedefNameType() && QTy->isPointerType()) {
+      std::string PointeeTy = DpctGlobalInfo::getTypeName(
         QTy->getPointeeType().getUnqualifiedType(), Context);
+      report(TL->getBeginLoc(), Diagnostics::KNOWN_UNSUPPORTED_TYPE, false,
+        PointeeTy + " *");
+      return;
+    }
     report(TL->getBeginLoc(), Diagnostics::KNOWN_UNSUPPORTED_TYPE, false,
-           PointeeTy + " *");
+      TypeName);
     return;
   }
-  report(TL->getBeginLoc(), Diagnostics::KNOWN_UNSUPPORTED_TYPE, false,
-         TypeName);
+  if (const TypeLoc *TL = getNodeAsType<TypeLoc>(Result, "alltypeloc")) {
+    recordRecognizedType(*TL);
+  }
 }
 
 REGISTER_RULE(RecognizeTypeRule, PassKind::PK_Migration)
diff --git a/clang/lib/DPCT/AnalysisInfo.cpp b/clang/lib/DPCT/AnalysisInfo.cpp
@@ -153,6 +153,7 @@ unsigned DpctGlobalInfo::ExtensionDEFlag = static_cast<unsigned>(-1);
 unsigned DpctGlobalInfo::ExtensionDDFlag = 0;
 unsigned DpctGlobalInfo::ExperimentalFlag = 0;
 unsigned DpctGlobalInfo::HelperFuncPreferenceFlag = 0;
+bool DpctGlobalInfo::AnalysisModeFlag = false;
 unsigned int DpctGlobalInfo::ColorOption = 1;
 std::unordered_map<int, std::shared_ptr<DeviceFunctionInfo>>
     DpctGlobalInfo::CubPlaceholderIndexMap;
diff --git a/clang/lib/DPCT/AnalysisInfo.h b/clang/lib/DPCT/AnalysisInfo.h
@@ -1012,6 +1012,8 @@ class DpctGlobalInfo {
   static unsigned getHelperFuncPreferenceFlag() {
     return HelperFuncPreferenceFlag;
   }
+  static bool isAnalysisModeEnabled() { return AnalysisModeFlag; }
+  static void enableAnalysisMode() { AnalysisModeFlag = true; }
 
   inline static format::FormatRange getFormatRange() { return FmtRng; }
   inline static void setFormatRange(format::FormatRange FR) { FmtRng = FR; }
@@ -2168,6 +2170,7 @@ class DpctGlobalInfo {
   static unsigned ExtensionDDFlag;
   static unsigned ExperimentalFlag;
   static unsigned HelperFuncPreferenceFlag;
+  static bool AnalysisModeFlag;
   static unsigned int ColorOption;
   static std::unordered_map<int, std::shared_ptr<DeviceFunctionInfo>>
       CubPlaceholderIndexMap;
diff --git a/clang/lib/DPCT/DPCT.cpp b/clang/lib/DPCT/DPCT.cpp
@@ -606,6 +606,10 @@ int runDPCT(int argc, const char **argv) {
     clang::tooling::SetDiagnosticOutput(DpctTerm());
   }
 
+  if (AnalysisMode) {
+    DpctGlobalInfo::enableAnalysisMode();
+    SuppressWarningsAllFlag = true;
+  }
   initWarningIDs();
 
   DpctInstallPath = getInstallPath(argv[0]);
@@ -1282,6 +1286,11 @@ int runDPCT(int argc, const char **argv) {
     }
   }
 
+  if (DpctGlobalInfo::isAnalysisModeEnabled()) {
+    dumpAnalysisModeStatics(llvm::outs());
+    return MigrationSucceeded;
+  }
+
   // if run was successful
   int Status = saveNewFiles(Tool, InRoot, OutRoot);
   ShowStatus(Status);
diff --git a/clang/lib/DPCT/Diagnostics.cpp b/clang/lib/DPCT/Diagnostics.cpp
@@ -34,14 +34,17 @@ bool checkDuplicated(const std::string &FileAndLine,
 std::unordered_map<int, DiagnosticsMessage> DiagnosticIDTable;
 std::unordered_map<int, DiagnosticsMessage> CommentIDTable;
 
+#define HIGH_LEVEL EffortLevel::EL_High
+#define MEDIUM_LEVEL EffortLevel::EL_Medium
+#define LOW_LEVEL EffortLevel::EL_Low
 
-#define DEF_WARNING(NAME, ID, LEVEL, MSG)                                             \
+#define DEF_WARNING(NAME, ID, LEVEL, MSG)                                      \
   DiagnosticsMessage wg_##NAME(DiagnosticIDTable, ID,                          \
-                               clang::DiagnosticIDs::Warning, MSG);
+                               clang::DiagnosticIDs::Warning, LEVEL, MSG);
 
-#define DEF_COMMENT(NAME, ID, LEVEL, MSG)                                             \
+#define DEF_COMMENT(NAME, ID, LEVEL, MSG)                                      \
   DiagnosticsMessage cg_##NAME(CommentIDTable, ID, clang::DiagnosticIDs::Note, \
-                               MSG);
+                               LEVEL, MSG);
 
 #include "Diagnostics.inc"
 
@@ -58,7 +61,8 @@ std::unordered_set<int> APIQueryNeedReportWarningIDSet = {
 
 std::unordered_map<int, DiagnosticsMessage> MsgIDTable;
 #define DEF_COMMENT(NAME, ID, MSG)                                             \
-  DiagnosticsMessage cg_##NAME(MsgIDTable, ID, clang::DiagnosticIDs::Note, MSG);
+  DiagnosticsMessage cg_##NAME(MsgIDTable, ID, clang::DiagnosticIDs::Note,     \
+                               EffortLevel::EL_Low, MSG);
 #include "DiagnosticsBuildScript.inc"
 #undef DEF_COMMENT
 
diff --git a/clang/lib/DPCT/Diagnostics.h b/clang/lib/DPCT/Diagnostics.h
@@ -43,6 +43,7 @@ extern std::set<int> WarningIDs;
 struct DiagnosticsMessage {
   int ID;
   int Category;
+  EffortLevel EL;
   const char *Msg;
 
 #define DEF_WARNING(NAME, ID, LEVEL, MSG) ID,
@@ -58,8 +59,8 @@ struct DiagnosticsMessage {
 #undef DEF_COMMENT
   DiagnosticsMessage() = default;
   DiagnosticsMessage(std::unordered_map<int, DiagnosticsMessage> &Table, int ID,
-                     int Category, const char *Msg)
-      : ID(ID), Category(Category), Msg(Msg) {
+                     int Category, EffortLevel EL, const char *Msg)
+      : ID(ID), Category(Category), EL(EL), Msg(Msg) {
     assert(Table.find(ID) == Table.end() && "[DPCT Internal error] Two "
                                             "messages with the same ID "
                                             "are being registered");
@@ -317,12 +318,17 @@ inline bool report(SourceLocation SL, IDTy MsgID,
   if (checkDuplicated(FileAndLine, WarningIDAndMsg))
     return false;
 
+  auto Diag = DiagnosticIDTable.find((int)MsgID);
+  if (Diag == DiagnosticIDTable.end())
+    return true;
+  if (DpctGlobalInfo::isAnalysisModeEnabled()) {
+    recordAnalysisModeEffort(SL, Diag->second.EL);
+    return true;
+  }
   if (!SuppressWarningsAllFlag) {
     // Only report warnings that are not suppressed
-    if (WarningIDs.find((int)MsgID) == WarningIDs.end() &&
-        DiagnosticIDTable.find((int)MsgID) != DiagnosticIDTable.end()) {
-      reportWarning(SL, DiagnosticIDTable[(int)MsgID], SM.getDiagnostics(),
-                    Vals...);
+    if (WarningIDs.find((int)MsgID) == WarningIDs.end()) {
+      reportWarning(SL, Diag->second, SM.getDiagnostics(), Vals...);
     }
   }
   if (TS && CommentIDTable.find((int)MsgID) != CommentIDTable.end()) {
@@ -402,12 +408,17 @@ bool report(const clang::tooling::UnifiedPath &FileAbsPath, unsigned int Offset,
   unsigned int ColNum = Offset - Fileinfo->getLineInfo(LineNum).Offset + 1;
   SourceLocation SL = SM.translateLineCol(FID, LineNum, ColNum);
 
+  auto Diag = DiagnosticIDTable.find((int)MsgID);
+  if (Diag == DiagnosticIDTable.end())
+    return true;
+  if (DpctGlobalInfo::isAnalysisModeEnabled()) {
+    recordAnalysisModeEffort(FileAbsPath, Offset, Diag->second.EL);
+    return true;
+  }
   if (!SuppressWarningsAllFlag) {
     // Only report warnings that are not suppressed
-    if (WarningIDs.find((int)MsgID) == WarningIDs.end() &&
-        DiagnosticIDTable.find((int)MsgID) != DiagnosticIDTable.end()) {
-      reportWarning(SL, DiagnosticIDTable[(int)MsgID], SM.getDiagnostics(),
-                    Vals...);
+    if (WarningIDs.find((int)MsgID) == WarningIDs.end()) {
+      reportWarning(SL, Diag->second, SM.getDiagnostics(), Vals...);
     }
   }
 
diff --git a/clang/lib/DPCT/MigrationAction.cpp b/clang/lib/DPCT/MigrationAction.cpp
@@ -174,6 +174,7 @@ std::shared_ptr<TranslationUnitInfo> DpctToolAction::createTranslationUnitInfo(
 
 std::shared_ptr<TranslationUnitInfo> DpctToolAction::createTranslationUnitInfoImpl(
     std::shared_ptr<CompilerInvocation> Invocation, bool &Success) {
+  Invocation->getDiagnosticOpts().IgnoreWarnings = true;
   auto DiagConsumer = new TextDiagnosticPrinter(
       DiagnosticStream, &Invocation->getDiagnosticOpts());
   auto Info = std::make_shared<TranslationUnitInfo>();
diff --git a/clang/lib/DPCT/Statics.cpp b/clang/lib/DPCT/Statics.cpp
diff --git a/clang/lib/DPCT/Statics.h b/clang/lib/DPCT/Statics.h
diff --git a/clang/test/dpct/autocomplete.c b/clang/test/dpct/autocomplete.c

Original file line number	Diff line number	Diff line change
`@@ -606,6 +606,10 @@ int runDPCT(int argc, const char **argv) {`
`606`	`606`	`clang::tooling::SetDiagnosticOutput(DpctTerm());`
`607`	`607`	`}`
`608`	`608`
	`609`	`+ if (AnalysisMode) {`
	`610`	`+ DpctGlobalInfo::enableAnalysisMode();`
	`611`	`+ SuppressWarningsAllFlag = true;`
	`612`	`+ }`
`609`	`613`	`initWarningIDs();`
`610`	`614`
`611`	`615`	`DpctInstallPath = getInstallPath(argv[0]);`
`@@ -1282,6 +1286,11 @@ int runDPCT(int argc, const char **argv) {`
`1282`	`1286`	`}`
`1283`	`1287`	`}`
`1284`	`1288`
	`1289`	`+ if (DpctGlobalInfo::isAnalysisModeEnabled()) {`
	`1290`	`+ dumpAnalysisModeStatics(llvm::outs());`
	`1291`	`+ return MigrationSucceeded;`
	`1292`	`+ }`
	`1293`	`+`
`1285`	`1294`	`// if run was successful`
`1286`	`1295`	`int Status = saveNewFiles(Tool, InRoot, OutRoot);`
`1287`	`1296`	`ShowStatus(Status);`