[Remarks] Simplify the creation of remark serializers

Introduce two new functions to create a serializer, and add support for
more combinations to the YAMLStrTabSerializer.

llvm-svn: 366919

4 files changed, 57 insertions, 17 deletions

diff --git a/llvm/lib/IR/RemarkStreamer.cpp b/llvm/lib/IR/RemarkStreamer.cpp
index cb2eeeb8616..2c01c8a0c5e 100644
--- a/llvm/lib/IR/RemarkStreamer.cpp
+++ b/llvm/lib/IR/RemarkStreamer.cpp
@@ -16,7 +16,7 @@
 #include "llvm/IR/Function.h"
 #include "llvm/IR/GlobalValue.h"
 #include "llvm/Remarks/RemarkFormat.h"
-#include "llvm/Remarks/YAMLRemarkSerializer.h"
+#include "llvm/Remarks/RemarkSerializer.h"
 
 using namespace llvm;
 
@@ -107,20 +107,6 @@ char RemarkSetupFileError::ID = 0;
 char RemarkSetupPatternError::ID = 0;
 char RemarkSetupFormatError::ID = 0;
 
-static std::unique_ptr<remarks::Serializer>
-formatToSerializer(remarks::Format RemarksFormat, raw_ostream &OS) {
-  switch (RemarksFormat) {
-  case remarks::Format::Unknown:
-    llvm_unreachable("Unknown remark serializer format.");
-    return nullptr;
-  case remarks::Format::YAML:
-    return llvm::make_unique<remarks::YAMLSerializer>(OS);
-  case remarks::Format::YAMLStrTab:
-    return llvm::make_unique<remarks::YAMLStrTabSerializer>(OS);
-  };
-  llvm_unreachable("Unknown remarks::Format enum");
-}
-
 Expected<std::unique_ptr<ToolOutputFile>>
 llvm::setupOptimizationRemarks(LLVMContext &Context, StringRef RemarksFilename,
                                StringRef RemarksPasses, StringRef RemarksFormat,
@@ -147,8 +133,13 @@ llvm::setupOptimizationRemarks(LLVMContext &Context, StringRef RemarksFilename,
   if (Error E = Format.takeError())
     return make_error<RemarkSetupFormatError>(std::move(E));
 
+  Expected<std::unique_ptr<remarks::Serializer>> Serializer =
+      remarks::createRemarkSerializer(*Format, RemarksFile->os());
+  if (Error E = Serializer.takeError())
+    return make_error<RemarkSetupFormatError>(std::move(E));
+
   Context.setRemarkStreamer(llvm::make_unique<RemarkStreamer>(
-      RemarksFilename, formatToSerializer(*Format, RemarksFile->os())));
+      RemarksFilename, std::move(*Serializer)));
 
   if (!RemarksPasses.empty())
     if (Error E = Context.getRemarkStreamer()->setFilter(RemarksPasses))
diff --git a/llvm/lib/Remarks/CMakeLists.txt b/llvm/lib/Remarks/CMakeLists.txt
index 06ddbab6de5..fff7367f1f7 100644
--- a/llvm/lib/Remarks/CMakeLists.txt
+++ b/llvm/lib/Remarks/CMakeLists.txt
@@ -2,6 +2,7 @@ add_llvm_library(LLVMRemarks
   Remark.cpp
   RemarkFormat.cpp
   RemarkParser.cpp
+  RemarkSerializer.cpp
   RemarkStringTable.cpp
   YAMLRemarkParser.cpp
   YAMLRemarkSerializer.cpp
diff --git a/llvm/lib/Remarks/RemarkFormat.cpp b/llvm/lib/Remarks/RemarkFormat.cpp
index 4e9ada63188..8dcf3e19345 100644
--- a/llvm/lib/Remarks/RemarkFormat.cpp
+++ b/llvm/lib/Remarks/RemarkFormat.cpp
@@ -24,7 +24,7 @@ Expected<Format> llvm::remarks::parseFormat(StringRef FormatStr) {
 
   if (Result == Format::Unknown)
     return createStringError(std::make_error_code(std::errc::invalid_argument),
-                             "Unknown remark serializer format: '%s'",
+                             "Unknown remark format: '%s'",
                              FormatStr.data());
 
   return Result;
diff --git a/llvm/lib/Remarks/RemarkSerializer.cpp b/llvm/lib/Remarks/RemarkSerializer.cpp
new file mode 100644
index 00000000000..b1cfd098134
--- /dev/null
+++ b/llvm/lib/Remarks/RemarkSerializer.cpp
@@ -0,0 +1,48 @@
+//===- RemarkSerializer.cpp -----------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file provides tools for serializing remarks.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Remarks/RemarkSerializer.h"
+#include "llvm/Remarks/YAMLRemarkSerializer.h"
+
+using namespace llvm;
+using namespace llvm::remarks;
+
+Expected<std::unique_ptr<Serializer>>
+remarks::createRemarkSerializer(Format RemarksFormat, raw_ostream &OS) {
+  switch (RemarksFormat) {
+  case Format::Unknown:
+    return createStringError(std::errc::invalid_argument,
+                             "Unknown remark serializer format.");
+  case Format::YAML:
+    return llvm::make_unique<YAMLSerializer>(OS);
+  case Format::YAMLStrTab:
+    return llvm::make_unique<YAMLStrTabSerializer>(OS);
+  }
+  llvm_unreachable("Unknown remarks::Format enum");
+}
+
+Expected<std::unique_ptr<Serializer>>
+remarks::createRemarkSerializer(Format RemarksFormat, raw_ostream &OS,
+                                remarks::StringTable StrTab) {
+  switch (RemarksFormat) {
+  case Format::Unknown:
+    return createStringError(std::errc::invalid_argument,
+                             "Unknown remark serializer format.");
+  case Format::YAML:
+    return createStringError(std::errc::invalid_argument,
+                             "Unable to use a string table with the yaml "
+                             "format. Use 'yaml-strtab' instead.");
+  case Format::YAMLStrTab:
+    return llvm::make_unique<YAMLStrTabSerializer>(OS, std::move(StrTab));
+  }
+  llvm_unreachable("Unknown remarks::Format enum");
+}