add support for summary format selection

Author: isuckatcs

clang/include/clang/Driver/Options.td

@@ -5954,6 +5954,9 @@ def emit_summaries : Flag<["-", "--"], "emit-summaries">, Flags<[NoXarchOption]>
   Visibility<[ClangOption]>,
   Alias<emit_summaries_EQ>, AliasArgs<["cwd"]>,
   HelpText<"Alias for --emit-summaries=cwd">;
+def summary_format_EQ : Joined<["-", "--"], "summary-format=">, Flags<[NoXarchOption]>,
+  Visibility<[ClangOption, CC1Option]>,
+  HelpText<"The format of the emitted summaries. Can be set to 'json' (default) or 'yaml'">;
 def save_stats_EQ : Joined<["-", "--"], "save-stats=">, Flags<[NoXarchOption]>,
   HelpText<"Save llvm statistics.">;
 def save_stats : Flag<["-", "--"], "save-stats">, Flags<[NoXarchOption]>,

clang/include/clang/Frontend/FrontendOptions.h

@@ -540,6 +540,9 @@ class FrontendOptions {
   /// The directory used to load summary files.
   std::string SummaryDirPath;
 
+  /// The format of the emitted summary files.
+  std::string SummaryFormat;
+
 public:
   FrontendOptions()
       : DisableFree(false), RelocatablePCH(false), ShowHelp(false),

clang/include/clang/Summary/SummarySerialization.h

@@ -30,6 +30,7 @@ class JSONSummarySerializer : public SummarySerializer {
 };
 
 class YAMLSummarySerializer : public SummarySerializer {
+public:
   YAMLSummarySerializer(SummaryContext &SummaryCtx)
       : SummarySerializer(SummaryCtx){};
 

clang/lib/Driver/ToolChains/Clang.cpp

@@ -5473,6 +5473,17 @@ void Clang::ConstructJob(Compilation &C, const JobAction &JA,
   if (Args.getLastArg(options::OPT_summaries_dir_EQ))
     Args.AddLastArg(CmdArgs, options::OPT_summaries_dir_EQ);
 
+  std::string SummaryFormat = "json";
+  if (Arg *A = Args.getLastArg(options::OPT_summary_format_EQ)) {
+    // FIXME: This logic is duplicated, so something is clearly wrong here...
+    StringRef Format = A->getValue();
+    if (Format == "json" || Format == "yaml")
+      SummaryFormat = Format;
+
+    Args.AddLastArg(CmdArgs, options::OPT_summary_format_EQ);
+  }
+
+  // FIXME: This arg shouldn't exist...
   if (const Arg *A = Args.getLastArg(options::OPT_emit_summaries_EQ)) {
     llvm::SmallString<10> input;
     for (const auto &II : Inputs) {
@@ -5496,7 +5507,7 @@ void Clang::ConstructJob(Compilation &C, const JobAction &JA,
       }
 
       if (!summaryFile.empty()) {
-        llvm::sys::path::replace_extension(summaryFile, "json");
+        llvm::sys::path::replace_extension(summaryFile, SummaryFormat);
         CmdArgs.push_back(
             Args.MakeArgString(Twine("-summary-file=") + summaryFile));
       }

clang/lib/Frontend/CompilerInstance.cpp

@@ -765,7 +765,15 @@ void CompilerInstance::createSummaryConsumer() {
 }
 
 void CompilerInstance::createSummarySerializer() {
-  TheSummarySerializer.reset(new JSONSummarySerializer(getSummaryContext()));
+  StringRef Format = getFrontendOpts().SummaryFormat;
+  SummarySerializer *Serializer;
+
+  if (Format == "yaml")
+    Serializer = new YAMLSummarySerializer(getSummaryContext());
+  else
+    Serializer = new JSONSummarySerializer(getSummaryContext());
+
+  TheSummarySerializer.reset(Serializer);
 }
 
 void CompilerInstance::createSema(TranslationUnitKind TUKind,

clang/lib/Frontend/CompilerInvocation.cpp

@@ -2985,6 +2985,8 @@ static void GenerateFrontendArgs(const FrontendOptions &Opts,
                 Lang + HeaderUnit + Header + ModuleMap + Preprocessed);
   }
 
+  GenerateArg(Consumer, OPT_summary_format_EQ, Opts.SummaryFormat);
+
   // OPT_INPUT has a unique class, generate it directly.
   for (const auto &Input : Opts.Inputs)
     Consumer(Input.getFile());
@@ -3263,6 +3265,15 @@ static bool ParseFrontendArgs(FrontendOptions &Opts, ArgList &Args,
     Opts.Inputs.emplace_back(std::move(Inputs[i]), IK, IsSystem);
   }
 
+  Opts.SummaryFormat = "json";
+  if (const Arg *A = Args.getLastArg(OPT_summary_format_EQ)) {
+    StringRef Format = A->getValue();
+
+    // FIXME: don't hardcode these values
+    if (Format == "json" || Format == "yaml")
+      Opts.SummaryFormat = Format;
+  };
+
   Opts.DashX = DashX;
 
   return Diags.getNumErrors() == NumErrorsBefore;

clang/lib/Frontend/FrontendAction.cpp

@@ -978,18 +978,21 @@ bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
   if (!CI.getFrontendOpts().SummaryDirPath.empty()) {
     // FIXME: this is a quick shortcut so large summaries are only evaluated
     // once, we should think about implementing it in a reasonable way...
-    static const char *reducedCache =
-        "reduced-summary-so-that-we-do-not-have-to-evaluate-it-every-time.json";
-    FileManager &FileMgr = CI.getFileManager();
+    static const char *reducedCacheName =
+        "reduced-summary-so-that-we-do-not-have-to-evaluate-it-every-time";
+    const std::string summaryExtension =
+        '.' + CI.getFrontendOpts().SummaryFormat;
 
+    FileManager &FileMgr = CI.getFileManager();
     StringRef SummaryDirPath = CI.getFrontendOpts().SummaryDirPath;
     if (auto SummaryDir = FileMgr.getOptionalDirectoryRef(SummaryDirPath)) {
       std::error_code EC;
       SmallString<128> DirNative;
       llvm::sys::path::native(SummaryDir->getName(), DirNative);
 
       llvm::vfs::FileSystem &FS = FileMgr.getVirtualFileSystem();
-      std::string cacheFile = DirNative.str().str() + '/' + reducedCache;
+      std::string cacheFile =
+          DirNative.str().str() + '/' + reducedCacheName + summaryExtension;
 
       std::vector<std::string> paths;
 
@@ -999,7 +1002,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()) != ".json")
+          if (llvm::sys::path::extension(Dir->path()) != summaryExtension)
             continue;
 
           paths.emplace_back(Dir->path().str());