flexible serailization

Author: isuckatcs

clang/include/clang/Frontend/CompilerInstance.h

@@ -124,6 +124,9 @@ class CompilerInstance : public ModuleLoader {
   /// The code completion consumer.
   std::unique_ptr<CodeCompleteConsumer> CompletionConsumer;
 
+  /// The summary serializer.
+  std::unique_ptr<SummarySerializer> TheSummarySerializer;
+
   /// The summary consumer.
   std::unique_ptr<SummaryConsumer> TheSummaryConsumer;
 
@@ -646,6 +649,16 @@ class CompilerInstance : public ModuleLoader {
 
   void createSummaryConsumer();
 
+  bool hasSummarySerializer() const { return (bool)TheSummarySerializer; }
+
+  SummarySerializer &getSummarySerializer() const {
+    assert(TheSummarySerializer &&
+           "Compiler instance has no code summary serializer!");
+    return *TheSummarySerializer;
+  }
+
+  void createSummarySerializer();
+
   /// @}
   /// @name Frontend timer
   /// @{

clang/include/clang/Summary/SummaryConsumer.h

@@ -1,13 +1,11 @@
 #ifndef LLVM_CLANG_SUMMARY_SUMMARYCONSUMER_H
 #define LLVM_CLANG_SUMMARY_SUMMARYCONSUMER_H
 
-#include "clang/Basic/LLVM.h"
-#include "llvm/Support/JSON.h"
-#include "llvm/Support/YAMLTraits.h"
-
+#include "llvm/Support/raw_ostream.h"
 namespace clang {
 class FunctionSummary;
 class SummaryContext;
+class SummarySerializer;
 
 class SummaryConsumer {
 protected:
@@ -22,37 +20,17 @@ class SummaryConsumer {
   virtual void ProcessEndOfSourceFile() {};
 };
 
-class PrintingSummaryConsumer : public SummaryConsumer {
-public:
-  PrintingSummaryConsumer(const SummaryContext &SummaryCtx, raw_ostream &OS)
-      : SummaryConsumer(SummaryCtx) {}
-};
-
-class JSONPrintingSummaryConsumer : public PrintingSummaryConsumer {
-  llvm::json::OStream JOS;
-
-public:
-  JSONPrintingSummaryConsumer(const SummaryContext &SummaryCtx, raw_ostream &OS)
-      : PrintingSummaryConsumer(SummaryCtx, OS), JOS(OS, 2) {}
-
-  void ProcessStartOfSourceFile() override { JOS.arrayBegin(); };
-  void ProcessFunctionSummary(const FunctionSummary &) override;
-  void ProcessEndOfSourceFile() override {
-    JOS.arrayEnd();
-    JOS.flush();
-  };
-};
-
-class YAMLPrintingSummaryConsumer : public PrintingSummaryConsumer {
+class SerializingSummaryConsumer : public SummaryConsumer {
   llvm::raw_ostream &OS;
-  llvm::yaml::Output YOS;
+  SummarySerializer *Serializer;
 
 public:
-   YAMLPrintingSummaryConsumer(const SummaryContext &SummaryCtx, raw_ostream &OS)
-      : PrintingSummaryConsumer(SummaryCtx, OS), OS(OS), YOS(OS) {}
+  SerializingSummaryConsumer(SummarySerializer &Serializer,
+                             llvm::raw_ostream &OS);
 
   void ProcessEndOfSourceFile() override;
 };
+
 } // namespace clang
 
 #endif // LLVM_CLANG_SUMMARY_SUMMARYCONSUMER_H

clang/include/clang/Summary/SummaryContext.h

@@ -3,6 +3,8 @@
 
 #include "clang/Summary/SummaryAttribute.h"
 #include "clang/Summary/SummaryConsumer.h"
+#include "llvm/Support/JSON.h"
+#include "llvm/Support/YAMLTraits.h"
 #include <set>
 
 namespace clang {
@@ -35,7 +37,8 @@ class FunctionSummary {
   }
 
   friend struct llvm::yaml::MappingTraits<clang::FunctionSummary>;
-  friend struct llvm::yaml::MappingContextTraits<clang::FunctionSummary, clang::SummaryContext>;
+  friend struct llvm::yaml::MappingContextTraits<clang::FunctionSummary,
+                                                 clang::SummaryContext>;
 };
 
 class SummaryContext {
@@ -56,9 +59,6 @@ class SummaryContext {
 
   const FunctionSummary *GetSummary(const FunctionDecl *FD) const;
   void SummarizeFunctionBody(const FunctionDecl *FD);
-
-  void ParseSummaryFromJSON(const llvm::json::Array &Summary);
-  void ParseSummaryFromYAML(StringRef content);
   void ReduceSummaries();
 };
 } // namespace clang

clang/include/clang/Summary/SummarySerialization.h

@@ -0,0 +1,42 @@
+#ifndef LLVM_CLANG_SUMMARY_SUMMARYSERIALIZATION_H
+#define LLVM_CLANG_SUMMARY_SUMMARYSERIALIZATION_H
+
+#include "clang/Summary/SummaryContext.h"
+
+namespace clang {
+class SummarySerializer {
+protected:
+  SummaryContext *SummaryCtx;
+
+public:
+  SummaryContext *getSummaryCtx() const { return SummaryCtx; }
+
+  SummarySerializer(SummaryContext &SummaryCtx) : SummaryCtx(&SummaryCtx){};
+  virtual ~SummarySerializer() = default;
+
+  virtual void serialize(const std::vector<std::unique_ptr<FunctionSummary>> &,
+                         raw_ostream &OS) = 0;
+  virtual void parse(StringRef) = 0;
+};
+
+class JSONSummarySerializer : public SummarySerializer {
+public:
+  JSONSummarySerializer(SummaryContext &SummaryCtx)
+      : SummarySerializer(SummaryCtx){};
+
+  void serialize(const std::vector<std::unique_ptr<FunctionSummary>> &,
+                 raw_ostream &OS) override;
+  void parse(StringRef) override;
+};
+
+class YAMLSummarySerializer : public SummarySerializer {
+  YAMLSummarySerializer(SummaryContext &SummaryCtx)
+      : SummarySerializer(SummaryCtx){};
+
+  void serialize(const std::vector<std::unique_ptr<FunctionSummary>> &,
+                 raw_ostream &OS) override;
+  void parse(StringRef) override;
+};
+} // namespace clang
+
+#endif // LLVM_CLANG_SUMMARY_SUMMARYSERIALIZATION_H

clang/include/clang/Summary/SummaryYamlMappings.h

@@ -42,6 +42,7 @@
 #include "clang/Serialization/InMemoryModuleCache.h"
 #include "clang/Serialization/ModuleCache.h"
 #include "clang/Summary/SummaryConsumer.h"
+#include "clang/Summary/SummarySerialization.h"
 #include "llvm/ADT/IntrusiveRefCntPtr.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/ScopeExit.h"
@@ -756,8 +757,15 @@ void CompilerInstance::createSummaryConsumer() {
     return;
   }
 
+  if (!hasSummarySerializer())
+    createSummarySerializer();
+
   TheSummaryConsumer.reset(
-      new YAMLPrintingSummaryConsumer(getSummaryContext(), *SummaryOS));
+      new SerializingSummaryConsumer(getSummarySerializer(), *SummaryOS));
+}
+
+void CompilerInstance::createSummarySerializer() {
+  TheSummarySerializer.reset(new JSONSummarySerializer(getSummaryContext()));
 }
 
 void CompilerInstance::createSema(TranslationUnitKind TUKind,

clang/lib/Frontend/CompilerInstance.cpp

@@ -39,6 +39,7 @@
 #include "clang/Serialization/ASTReader.h"
 #include "clang/Serialization/GlobalModuleIndex.h"
 #include "clang/Summary/SummaryContext.h"
+#include "clang/Summary/SummarySerialization.h"
 #include "llvm/ADT/ScopeExit.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/BuryPointer.h"
@@ -970,6 +971,9 @@ bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
   if (ProcessesSummaries && !CI.hasSummaryContext())
     CI.createSummaryContext();
 
+  if (ProcessesSummaries && !CI.hasSummarySerializer())
+    CI.createSummarySerializer();
+
   // FIXME: cleanup and lookup dirs recursively
   if (!CI.getFrontendOpts().SummaryDirPath.empty()) {
     // FIXME: this is a quick shortcut so large summaries are only evaluated
@@ -995,7 +999,7 @@ bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
         for (llvm::vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC),
                                            DirEnd;
              Dir != DirEnd && !EC; Dir.increment(EC)) {
-          if (llvm::sys::path::extension(Dir->path()) != ".yaml")
+          if (llvm::sys::path::extension(Dir->path()) != ".json")
             continue;
 
           paths.emplace_back(Dir->path().str());
@@ -1007,31 +1011,16 @@ bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
         std::stringstream buffer;
         buffer << t.rdbuf();
 
-        llvm::outs() << buffer.str() << '\n';
-
-        CI.getSummaryContext().ParseSummaryFromYAML(buffer.str());
-
-
-        // auto JSON = llvm::json::parse(buffer.str());
-        // if (!!JSON)
-        //   CI.getSummaryContext().ParseSummaryFromJSON(*JSON->getAsArray());
-
-        // llvm::handleAllErrors(
-        //     JSON.takeError(),
-        //     [](const llvm::ErrorInfoBase &EI) { std::ignore = EI.message(); });
+        CI.getSummarySerializer().parse(buffer.str());
       }
 
       CI.getSummaryContext().ReduceSummaries();
 
       if (!FS.exists(cacheFile)) {
         // FIXME: very quick printing of the summary to the cache file
         llvm::raw_fd_ostream fd(cacheFile, EC, llvm::sys::fs::CD_CreateAlways);
-
-        JSONPrintingSummaryConsumer printer(CI.getSummaryContext(), fd);
-        printer.ProcessStartOfSourceFile();
-        for (auto &&Summary : CI.getSummaryContext().FunctionSummaries)
-          printer.ProcessFunctionSummary(*Summary);
-        printer.ProcessEndOfSourceFile();
+        CI.getSummarySerializer().serialize(
+            CI.getSummaryContext().FunctionSummaries, fd);
       }
     }
   }

clang/lib/Frontend/FrontendAction.cpp

@@ -238,11 +238,11 @@ ProgramStateRef CallEvent::invalidateRegions(unsigned BlockCount,
 
   if (const Decl *callee = getDecl()) {
     const SummaryContext *SummaryCtx =
-      State->getStateManager().getOwningEngine().getSummaryCtx();
+        State->getStateManager().getOwningEngine().getSummaryCtx();
     const FunctionDecl *FD = llvm::dyn_cast<FunctionDecl>(callee);
     if (SummaryCtx && FD)
       Summary = SummaryCtx->GetSummary(FD);
-    
+
     // Don't invalidate anything if the callee is marked pure/const.
     if (callee->hasAttr<PureAttr>() || callee->hasAttr<ConstAttr>())
       return Result;
@@ -259,7 +259,7 @@ ProgramStateRef CallEvent::invalidateRegions(unsigned BlockCount,
     findPtrToConstParams(PreserveArgs, *this);
 
   for (unsigned Idx = 0, Count = getNumArgs(); Idx != Count; ++Idx) {
-    if(Summary && Summary->hasAttribute<NoWritePtrParameterAttr>())
+    if (Summary && Summary->hasAttribute<NoWritePtrParameterAttr>())
       continue;
 
     // Mark this region for invalidation.  We batch invalidate regions
@@ -288,7 +288,8 @@ ProgramStateRef CallEvent::invalidateRegions(unsigned BlockCount,
             ValuesToInvalidate.push_back(loc::MemRegionVal(TVR));
   }
 
-  bool ShouldPreserveGlobals = Summary && Summary->hasAttribute<NoWriteGlobalAttr>();
+  bool ShouldPreserveGlobals =
+      Summary && Summary->hasAttribute<NoWriteGlobalAttr>();
 
   // Invalidate designated regions using the batch invalidation API.
   // NOTE: Even if RegionsToInvalidate is empty, we may still invalidate

clang/lib/StaticAnalyzer/Core/CallEvent.cpp

@@ -7,7 +7,7 @@ add_clang_library(clangSummary
   SummaryAttribute.cpp
   SummaryConsumer.cpp
   SummaryContext.cpp
-  SummaryYamlMappings.cpp
+  SummarySerialization.cpp
 
   LINK_LIBS
   clangAST

clang/lib/Summary/CMakeLists.txt

@@ -1,32 +1,14 @@
 #include "clang/Summary/SummaryConsumer.h"
 #include "clang/Summary/SummaryContext.h"
-#include "clang/Summary/SummaryYamlMappings.h"
+#include "clang/Summary/SummarySerialization.h"
 
 namespace clang {
-void JSONPrintingSummaryConsumer::ProcessFunctionSummary(
-    const FunctionSummary &Summary) {
-  JOS.object([&] {
-    JOS.attribute("id", llvm::json::Value(Summary.getID()));
-    JOS.attributeObject("attrs", [&] {
-      JOS.attributeArray("function", [&] {
-        for (auto &&Attr : Summary.getAttributes()) {
-          JOS.value(llvm::json::Value(Attr->serialize()));
-        }
-      });
-    });
-    JOS.attributeObject("calls", [&] {
-      JOS.attribute("opaque", llvm::json::Value(Summary.callsOpaqueObject()));
-      JOS.attributeArray("functions", [&] {
-        for (auto &&Call : Summary.getCalls()) {
-          JOS.object([&] { JOS.attribute("id", llvm::json::Value(Call)); });
-        }
-      });
-    });
-  });
-}
+SerializingSummaryConsumer::SerializingSummaryConsumer(
+    SummarySerializer &Serializer, llvm::raw_ostream &OS)
+    : SummaryConsumer(*Serializer.getSummaryCtx()), OS(OS),
+      Serializer(&Serializer) {}
 
-void YAMLPrintingSummaryConsumer::ProcessEndOfSourceFile() {
-  YOS << ((SummaryContext *)SummaryCtx)->FunctionSummaries;
-  OS.flush();
+void SerializingSummaryConsumer::ProcessEndOfSourceFile() {
+  Serializer->serialize(SummaryCtx->FunctionSummaries, OS);
 }
 } // namespace clang