[OptRemarks] Make OptRemarks more generic: rename OptRemarks to Remarks

Getting rid of the name "optimization remarks" for anything that
involves handling remarks on the client side.

It's safer to do this now, before we get stuck with that name in all the
APIs and public interfaces we decide to export to users in the future.

This renames llvm/tools/opt-remarks to llvm/tools/remarks-shlib, and now
generates `libRemarks.dylib` instead of `libOptRemarks.dylib`.

Differential Revision: https://reviews.llvm.org/D58535

llvm-svn: 355439

6 files changed, 37 insertions, 38 deletions

diff --git a/llvm/lib/CMakeLists.txt b/llvm/lib/CMakeLists.txt
index f25c7a09855..c458927e3cd 100644
--- a/llvm/lib/CMakeLists.txt
+++ b/llvm/lib/CMakeLists.txt
@@ -16,7 +16,7 @@ add_subdirectory(MCA)
 add_subdirectory(Object)
 add_subdirectory(ObjectYAML)
 add_subdirectory(Option)
-add_subdirectory(OptRemarks)
+add_subdirectory(Remarks)
 add_subdirectory(DebugInfo)
 add_subdirectory(ExecutionEngine)
 add_subdirectory(Target)
diff --git a/llvm/lib/LLVMBuild.txt b/llvm/lib/LLVMBuild.txt
index 838624b02a0..3b5e71d6ef1 100644
--- a/llvm/lib/LLVMBuild.txt
+++ b/llvm/lib/LLVMBuild.txt
@@ -35,7 +35,7 @@ subdirectories =
  BinaryFormat
  ObjectYAML
  Option
- OptRemarks
+ Remarks
  Passes
  ProfileData
  Support
diff --git a/llvm/lib/OptRemarks/CMakeLists.txt b/llvm/lib/OptRemarks/CMakeLists.txt
deleted file mode 100644
index 8fefe1d986b..00000000000
--- a/llvm/lib/OptRemarks/CMakeLists.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-add_llvm_library(LLVMOptRemarks
-  OptRemarksParser.cpp
-)
diff --git a/llvm/lib/Remarks/CMakeLists.txt b/llvm/lib/Remarks/CMakeLists.txt
new file mode 100644
index 00000000000..83713d66a60
--- /dev/null
+++ b/llvm/lib/Remarks/CMakeLists.txt
@@ -0,0 +1,3 @@
+add_llvm_library(LLVMRemarks
+  RemarkParser.cpp
+)
diff --git a/llvm/lib/OptRemarks/LLVMBuild.txt b/llvm/lib/Remarks/LLVMBuild.txt
index a2962690d75..bf7c52c876b 100644
--- a/llvm/lib/OptRemarks/LLVMBuild.txt
+++ b/llvm/lib/Remarks/LLVMBuild.txt
@@ -1,4 +1,4 @@
-;===- ./lib/OptRemarks/LLVMBuild.txt ---------------------------*- Conf -*--===;
+;===- ./lib/Remarks/LLVMBuild.txt ------------------------------*- Conf -*--===;
 ;
 ; Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 ; See https://llvm.org/LICENSE.txt for license information.
@@ -16,6 +16,6 @@
 
 [component_0]
 type = Library
-name = OptRemarks
+name = Remarks
 parent = Libraries
 required_libraries = Support
diff --git a/llvm/lib/OptRemarks/OptRemarksParser.cpp b/llvm/lib/Remarks/RemarkParser.cpp
index 18c0df27993..bee86ee954c 100644
--- a/llvm/lib/OptRemarks/OptRemarksParser.cpp
+++ b/llvm/lib/Remarks/RemarkParser.cpp
@@ -1,4 +1,4 @@
-//===- OptRemarksParser.cpp -----------------------------------------------===//
+//===- RemarkParser.cpp --------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -7,11 +7,11 @@
 //===----------------------------------------------------------------------===//
 //
 // This file provides utility methods used by clients that want to use the
-// parser for optimization remarks in LLVM.
+// parser for remark diagnostics in LLVM.
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm-c/OptRemarks.h"
+#include "llvm-c/Remarks.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/Support/SourceMgr.h"
 #include "llvm/Support/YAMLTraits.h"
@@ -31,14 +31,14 @@ struct RemarkParser {
   /// Iterator in the YAML stream.
   yaml::document_iterator DI;
   /// The parsed remark (if any).
-  Optional<LLVMOptRemarkEntry> LastRemark;
+  Optional<LLVMRemarkEntry> LastRemark;
   /// Temporary parsing buffer for the arguments.
-  SmallVector<LLVMOptRemarkArg, 8> TmpArgs;
+  SmallVector<LLVMRemarkArg, 8> TmpArgs;
   /// The state used by the parser to parse a remark entry. Invalidated with
   /// every call to `parseYAMLElement`.
   struct ParseState {
     /// Temporary parsing buffer for the arguments.
-    SmallVectorImpl<LLVMOptRemarkArg> *Args;
+    SmallVectorImpl<LLVMRemarkArg> *Args;
     StringRef Type;
     StringRef Pass;
     StringRef Name;
@@ -49,7 +49,7 @@ struct RemarkParser {
     Optional<unsigned> Column;
     Optional<unsigned> Hotness;
 
-    ParseState(SmallVectorImpl<LLVMOptRemarkArg> &Args) : Args(&Args) {}
+    ParseState(SmallVectorImpl<LLVMRemarkArg> &Args) : Args(&Args) {}
     /// Use Args only as a **temporary** buffer.
     ~ParseState() { Args->clear(); }
   };
@@ -80,7 +80,7 @@ private:
   Error parseDebugLoc(Optional<StringRef> &File, Optional<unsigned> &Line,
                       Optional<unsigned> &Column, yaml::KeyValueNode &Node);
   /// Parse an argument.
-  Error parseArg(SmallVectorImpl<LLVMOptRemarkArg> &TmpArgs, yaml::Node &Node);
+  Error parseArg(SmallVectorImpl<LLVMRemarkArg> &TmpArgs, yaml::Node &Node);
 
   /// Handle a diagnostic from the YAML stream. Records the error in the
   /// RemarkParser class.
@@ -114,7 +114,7 @@ private:
 
 char ParseError::ID = 0;
 
-static LLVMOptRemarkStringRef toOptRemarkStr(StringRef Str) {
+static LLVMRemarkStringRef toRemarkStr(StringRef Str) {
   return {Str.data(), static_cast<uint32_t>(Str.size())};
 }
 
@@ -190,7 +190,7 @@ Error RemarkParser::parseDebugLoc(Optional<StringRef> &File,
   return Error::success();
 }
 
-Error RemarkParser::parseArg(SmallVectorImpl<LLVMOptRemarkArg> &Args,
+Error RemarkParser::parseArg(SmallVectorImpl<LLVMRemarkArg> &Args,
                              yaml::Node &Node) {
   auto *ArgMap = dyn_cast<yaml::MappingNode>(&Node);
   if (!ArgMap)
@@ -237,10 +237,10 @@ Error RemarkParser::parseArg(SmallVectorImpl<LLVMOptRemarkArg> &Args,
   if (ValueStr.empty())
     return make_error<ParseError>("argument value is missing.", *ArgMap);
 
-  Args.push_back(LLVMOptRemarkArg{
-      toOptRemarkStr(KeyStr), toOptRemarkStr(ValueStr),
-      LLVMOptRemarkDebugLoc{toOptRemarkStr(File.getValueOr(StringRef())),
-                            Line.getValueOr(0), Column.getValueOr(0)}});
+  Args.push_back(LLVMRemarkArg{
+      toRemarkStr(KeyStr), toRemarkStr(ValueStr),
+      LLVMRemarkDebugLoc{toRemarkStr(File.getValueOr(StringRef())),
+                         Line.getValueOr(0), Column.getValueOr(0)}});
 
   return Error::success();
 }
@@ -302,14 +302,13 @@ Error RemarkParser::parseYAMLElement(yaml::Document &Remark) {
     return make_error<ParseError>("Type, Pass, Name or Function missing.",
                                   *Remark.getRoot());
 
-  LastRemark = LLVMOptRemarkEntry{
-      toOptRemarkStr(State.Type),
-      toOptRemarkStr(State.Pass),
-      toOptRemarkStr(State.Name),
-      toOptRemarkStr(State.Function),
-      LLVMOptRemarkDebugLoc{toOptRemarkStr(State.File.getValueOr(StringRef())),
-                            State.Line.getValueOr(0),
-                            State.Column.getValueOr(0)},
+  LastRemark = LLVMRemarkEntry{
+      toRemarkStr(State.Type),
+      toRemarkStr(State.Pass),
+      toRemarkStr(State.Name),
+      toRemarkStr(State.Function),
+      LLVMRemarkDebugLoc{toRemarkStr(State.File.getValueOr(StringRef())),
+                         State.Line.getValueOr(0), State.Column.getValueOr(0)},
       State.Hotness.getValueOr(0),
       static_cast<uint32_t>(State.Args->size()),
       State.Args->data()};
@@ -319,16 +318,16 @@ Error RemarkParser::parseYAMLElement(yaml::Document &Remark) {
 } // namespace
 
 // Create wrappers for C Binding types (see CBindingWrapping.h).
-DEFINE_SIMPLE_CONVERSION_FUNCTIONS(RemarkParser, LLVMOptRemarkParserRef)
+DEFINE_SIMPLE_CONVERSION_FUNCTIONS(RemarkParser, LLVMRemarkParserRef)
 
-extern "C" LLVMOptRemarkParserRef LLVMOptRemarkParserCreate(const void *Buf,
-                                                            uint64_t Size) {
+extern "C" LLVMRemarkParserRef LLVMRemarkParserCreate(const void *Buf,
+                                                      uint64_t Size) {
   return wrap(
       new RemarkParser(StringRef(static_cast<const char *>(Buf), Size)));
 }
 
-extern "C" LLVMOptRemarkEntry *
-LLVMOptRemarkParserGetNext(LLVMOptRemarkParserRef Parser) {
+extern "C" LLVMRemarkEntry *
+LLVMRemarkParserGetNext(LLVMRemarkParserRef Parser) {
   RemarkParser &TheParser = *unwrap(Parser);
   // Check for EOF.
   if (TheParser.HadAnyErrors || TheParser.DI == TheParser.Stream.end())
@@ -348,20 +347,20 @@ LLVMOptRemarkParserGetNext(LLVMOptRemarkParserRef Parser) {
   ++TheParser.DI;
 
   // Return the just-parsed remark.
-  if (Optional<LLVMOptRemarkEntry> &Entry = TheParser.LastRemark)
+  if (Optional<LLVMRemarkEntry> &Entry = TheParser.LastRemark)
     return &*Entry;
   return nullptr;
 }
 
-extern "C" LLVMBool LLVMOptRemarkParserHasError(LLVMOptRemarkParserRef Parser) {
+extern "C" LLVMBool LLVMRemarkParserHasError(LLVMRemarkParserRef Parser) {
   return unwrap(Parser)->HadAnyErrors;
 }
 
 extern "C" const char *
-LLVMOptRemarkParserGetErrorMessage(LLVMOptRemarkParserRef Parser) {
+LLVMRemarkParserGetErrorMessage(LLVMRemarkParserRef Parser) {
   return unwrap(Parser)->ErrorStream.str().c_str();
 }
 
-extern "C" void LLVMOptRemarkParserDispose(LLVMOptRemarkParserRef Parser) {
+extern "C" void LLVMRemarkParserDispose(LLVMRemarkParserRef Parser) {
   delete unwrap(Parser);
 }