Merge pull request swiftlang#29650 from francisvm/sil-remark-streamer

[Remarks] Add a specialized RemarkStreamer for SIL remarks

Author: francisvm

include/swift/AST/DiagnosticsFrontend.def

@@ -372,6 +372,8 @@ NOTE(compiled_module_invalid_reason,none,
 ERROR(unknown_forced_module_loading_mode,none,
       "unknown value for SWIFT_FORCE_MODULE_LOADING variable: '%0'",
       (StringRef))
+ERROR(error_creating_remark_serializer,none,
+      "error while creating remark serializer: '%0'", (StringRef))
 
 REMARK(interface_file_lock_failure,none,
       "could not acquire lock file for module interface '%0'", (StringRef))

include/swift/AST/SILOptions.h

@@ -23,6 +23,7 @@
 #include "swift/Basic/OptimizationMode.h"
 #include "llvm/ADT/Hashing.h"
 #include "llvm/ADT/StringRef.h"
+#include "llvm/Remarks/RemarkFormat.h"
 #include <string>
 #include <climits>
 
@@ -161,10 +162,17 @@ class SILOptions {
   /// pipeline or after serialization.
   bool StripOwnershipAfterSerialization = true;
 
-  /// The name of the file to which the backend should save YAML optimization
+  /// The name of the file to which the backend should save optimization
   /// records.
   std::string OptRecordFile;
 
+  /// The regex that filters the passes that should be saved to the optimization
+  /// records.
+  std::string OptRecordPasses;
+
+  /// The format used for serializing remarks (default: YAML)
+  llvm::remarks::Format OptRecordFormat = llvm::remarks::Format::YAML;
+
   SILOptions() {}
 
   /// Return a hash code of any components from these options that should

include/swift/Basic/FileTypes.def

@@ -72,7 +72,8 @@ TYPE("tbd",                 TBD,                       "tbd",             "")
 TYPE("module-trace",        ModuleTrace,               "trace.json",      "")
 
 TYPE("index-data",          IndexData,                 "",                "")
-TYPE("opt-record",          OptRecord,                 "opt.yaml",        "")
+TYPE("yaml-opt-record",     YAMLOptRecord,             "opt.yaml",        "")
+TYPE("bitstream-opt-record",BitstreamOptRecord,        "opt.bitstream",   "")
 
 // Overlay files declare wrapper modules, called "separately-imported overlays",
 // that should be automatically imported when a particular module is imported.

include/swift/Driver/ToolChain.h

@@ -317,6 +317,9 @@ class ToolChain {
   virtual void validateArguments(DiagnosticEngine &diags,
                                  const llvm::opt::ArgList &args,
                                  StringRef defaultTarget) const {}
+
+  llvm::Expected<file_types::ID>
+  remarkFileTypeFromArgs(const llvm::opt::ArgList &Args) const;
 };
 } // end namespace driver
 } // end namespace swift

include/swift/Option/Options.td

@@ -548,10 +548,20 @@ def Rpass_missed_EQ : Joined<["-"], "Rpass-missed=">,
 
 def save_optimization_record : Flag<["-"], "save-optimization-record">,
   Flags<[FrontendOption]>, HelpText<"Generate a YAML optimization record file">;
+def save_optimization_record_EQ : Joined<["-"], "save-optimization-record=">,
+  Flags<[FrontendOption]>,
+  HelpText<"Generate an optimization record file in a specific format "
+           "(default: YAML)">, MetaVarName<"<format>">;
 def save_optimization_record_path :
   Separate<["-"], "save-optimization-record-path">,
   Flags<[FrontendOption, ArgumentIsPath]>,
-  HelpText<"Specify the file name of any generated YAML optimization record">;
+  HelpText<"Specify the file name of any generated optimization record">;
+def save_optimization_record_passes :
+  Separate<["-"], "save-optimization-record-passes">,
+  Flags<[FrontendOption]>,
+  HelpText<"Only include passes which match a specified regular expression in"
+           "the generated optimization record "
+           "(by default, include all passes)">, MetaVarName<"<regex>">;
 
 // Platform options.
 def enable_app_extension : Flag<["-"], "application-extension">,

include/swift/SIL/OptimizationRemark.h

@@ -20,6 +20,7 @@
 #define SWIFT_SIL_OPTIMIZATIONREMARKEMITTER_H
 
 #include "swift/Basic/SourceLoc.h"
+#include "swift/Demangling/Demangler.h"
 #include "swift/SIL/SILBasicBlock.h"
 #include "swift/SIL/SILInstruction.h"
 #include "swift/SIL/SILModule.h"
@@ -34,24 +35,24 @@ namespace OptRemark {
 /// Used in the streaming interface as the general argument type.  It
 /// internally converts everything into a key-value pair.
 struct Argument {
-  std::string Key;
-  std::string Val;
+  std::string key;
+  std::string val;
   /// If set, the debug location corresponding to the value.
-  SourceLoc Loc;
+  SourceLoc loc;
 
-  explicit Argument(StringRef Str = "") : Key("String"), Val(Str) {}
-  Argument(StringRef Key, StringRef Val) : Key(Key), Val(Val) {}
+  explicit Argument(StringRef Str = "") : key("String"), val(Str) {}
+  Argument(StringRef key, StringRef val) : key(key), val(val) {}
 
-  Argument(StringRef Key, int N);
-  Argument(StringRef Key, long N);
-  Argument(StringRef Key, long long N);
-  Argument(StringRef Key, unsigned N);
-  Argument(StringRef Key, unsigned long N);
-  Argument(StringRef Key, unsigned long long N);
+  Argument(StringRef key, int n);
+  Argument(StringRef key, long n);
+  Argument(StringRef key, long long n);
+  Argument(StringRef key, unsigned n);
+  Argument(StringRef key, unsigned long n);
+  Argument(StringRef key, unsigned long long n);
 
-  Argument(StringRef Key, SILFunction *F);
-  Argument(StringRef Key, SILType Ty);
-  Argument(StringRef Key, CanType Ty);
+  Argument(StringRef key, SILFunction *f);
+  Argument(StringRef key, SILType ty);
+  Argument(StringRef key, CanType ty);
 };
 
 /// Shorthand to insert named-value pairs.
@@ -60,132 +61,142 @@ using NV = Argument;
 /// Inserting this into a Remark indents the text when printed as a debug
 /// message.
 struct IndentDebug {
-  explicit IndentDebug(unsigned Width) : Width(Width) {}
-  unsigned Width;
+  explicit IndentDebug(unsigned width) : width(width) {}
+  unsigned width;
 };
 
 /// The base class for remarks.  This can be created by optimization passed to
 /// report successful and unsuccessful optimizations. CRTP is used to preserve
 /// the underlying type encoding the remark kind in the insertion operator.
 template <typename DerivedT> class Remark {
   /// Arguments collected via the streaming interface.
-  SmallVector<Argument, 4> Args;
+  SmallVector<Argument, 4> args;
 
   /// The name of the pass generating the remark.
-  StringRef PassName;
+  StringRef passName;
 
   /// Textual identifier for the remark (single-word, camel-case). Can be used
-  /// by external tools reading the YAML output file for optimization remarks to
+  /// by external tools reading the output file for optimization remarks to
   /// identify the remark.
-  StringRef Identifier;
+  SmallString<32> identifier;
 
   /// Source location for the diagnostics.
-  SourceLoc Location;
+  SourceLoc location;
 
   /// The function for the diagnostics.
-  SILFunction *Function;
+  SILFunction *function;
+
+  /// The demangled name of \p Function.
+  SmallString<64> demangledFunctionName;
 
   /// Indentation used if this remarks is printed as a debug message.
-  unsigned IndentDebugWidth = 0;
+  unsigned indentDebugWidth = 0;
 
 protected:
-  Remark(StringRef Identifier, SILInstruction &I)
-      : Identifier(Identifier), Location(I.getLoc().getSourceLoc()),
-        Function(I.getParent()->getParent()) {}
+  Remark(StringRef identifier, SILInstruction &i)
+      : identifier((Twine("sil.") + identifier).str()),
+        location(i.getLoc().getSourceLoc()),
+        function(i.getParent()->getParent()),
+        demangledFunctionName(Demangle::demangleSymbolAsString(
+            function->getName(),
+            Demangle::DemangleOptions::SimplifiedUIDemangleOptions())) {}
 
 public:
-  DerivedT &operator<<(StringRef S) {
-    Args.emplace_back(S);
+  DerivedT &operator<<(StringRef s) {
+    args.emplace_back(s);
     return *static_cast<DerivedT *>(this);
   }
 
-  DerivedT &operator<<(Argument A) {
-    Args.push_back(std::move(A));
+  DerivedT &operator<<(Argument a) {
+    args.push_back(std::move(a));
     return *static_cast<DerivedT *>(this);
   }
 
-  DerivedT &operator<<(IndentDebug ID) {
-    IndentDebugWidth = ID.Width;
+  DerivedT &operator<<(IndentDebug indent) {
+    indentDebugWidth = indent.width;
     return *static_cast<DerivedT *>(this);
   }
 
-  StringRef getPassName() const { return PassName; }
-  StringRef getIdentifier() const { return Identifier; }
-  SILFunction *getFunction() const { return Function; }
-  SourceLoc getLocation() const { return Location; }
+  StringRef getPassName() const { return passName; }
+  StringRef getIdentifier() const { return identifier; }
+  SILFunction *getFunction() const { return function; }
+  StringRef getDemangledFunctionName() const { return demangledFunctionName; }
+  SourceLoc getLocation() const { return location; }
   std::string getMsg() const;
   std::string getDebugMsg() const;
   Remark<DerivedT> &getRemark() { return *this; }
-  SmallVector<Argument, 4> &getArgs() { return Args; }
+  SmallVector<Argument, 4> &getArgs() { return args; }
+  ArrayRef<Argument> getArgs() const { return args; }
 
-  void setPassName(StringRef PN) { PassName = PN; }
+  void setPassName(StringRef name) { passName = name; }
 };
 
 /// Remark to report a successful optimization.
 struct RemarkPassed : public Remark<RemarkPassed> {
-  RemarkPassed(StringRef Id, SILInstruction &I) : Remark(Id, I) {}
+  RemarkPassed(StringRef id, SILInstruction &i) : Remark(id, i) {}
 };
 /// Remark to report a unsuccessful optimization.
 struct RemarkMissed : public Remark<RemarkMissed> {
-  RemarkMissed(StringRef Id, SILInstruction &I) : Remark(Id, I) {}
+  RemarkMissed(StringRef id, SILInstruction &i) : Remark(id, i) {}
 };
 
 /// Used to emit the remarks.  Passes reporting remarks should create an
 /// instance of this.
 class Emitter {
-  SILModule &Module;
-  std::string PassName;
-  bool PassedEnabled;
-  bool MissedEnabled;
+  SILModule &module;
+  std::string passName;
+  bool passedEnabled;
+  bool missedEnabled;
 
   // Making these non-generic allows out-of-line definition.
-  void emit(const RemarkPassed &R);
-  void emit(const RemarkMissed &R);
-  static void emitDebug(const RemarkPassed &R);
-  static void emitDebug(const RemarkMissed &R);
+  void emit(const RemarkPassed &remark);
+  void emit(const RemarkMissed &remark);
+  static void emitDebug(const RemarkPassed &remark);
+  static void emitDebug(const RemarkMissed &remark);
 
   template <typename RemarkT> bool isEnabled();
 
 public:
-  Emitter(StringRef PassName, SILModule &M);
+  Emitter(StringRef passName, SILModule &m);
 
   /// Take a lambda that returns a remark which will be emitted.  The
   /// lambda is not evaluated unless remarks are enabled.  Second argument is
   /// only used to restrict this to functions.
   template <typename T>
-  void emit(T RemarkBuilder, decltype(RemarkBuilder()) * = nullptr) {
-    using RemarkT = decltype(RemarkBuilder());
+  void emit(T remarkBuilder, decltype(remarkBuilder()) * = nullptr) {
+    using RemarkT = decltype(remarkBuilder());
     // Avoid building the remark unless remarks are enabled.
-    if (isEnabled<RemarkT>() || Module.getOptRecordStream()) {
-      auto rb = RemarkBuilder();
-      rb.setPassName(PassName);
+    if (isEnabled<RemarkT>() || module.getSILRemarkStreamer()) {
+      auto rb = remarkBuilder();
+      rb.setPassName(passName);
       emit(rb);
     }
   }
 
   /// Emit an optimization remark or debug message.
   template <typename T>
-  static void emitOrDebug(const char *PassName, Emitter *ORE, T RemarkBuilder,
-                          decltype(RemarkBuilder()) * = nullptr) {
-    using RemarkT = decltype(RemarkBuilder());
+  static void emitOrDebug(const char *passName, Emitter *emitter,
+                          T remarkBuilder,
+                          decltype(remarkBuilder()) * = nullptr) {
+    using RemarkT = decltype(remarkBuilder());
     // Avoid building the remark unless remarks are enabled.
-    bool EmitRemark =
-        ORE && (ORE->isEnabled<RemarkT>() || ORE->Module.getOptRecordStream());
+    bool emitRemark = emitter && (emitter->isEnabled<RemarkT>() ||
+                                  emitter->module.getSILRemarkStreamer());
     // Same for DEBUG.
-    bool EmitDebug = false;
+    bool shouldEmitDebug = false;
 #ifndef NDEBUG
-    EmitDebug |= llvm::DebugFlag && llvm::isCurrentDebugType(PassName);
+    shouldEmitDebug |= llvm::DebugFlag && llvm::isCurrentDebugType(passName);
 #endif // NDEBUG
 
-    if (EmitRemark || EmitDebug) {
-      auto R = RemarkBuilder();
-      if (EmitDebug)
-        emitDebug(R);
-      if (EmitRemark) {
-        // If we have ORE use the PassName that was set up with ORE. DEBUG_TYPE
+    if (emitRemark || shouldEmitDebug) {
+      auto r = remarkBuilder();
+      if (shouldEmitDebug)
+        emitDebug(r);
+      if (emitRemark) {
+        // If we have an Emitter use the PassName that was set up. DEBUG_TYPE
         // may be different if a pass is calling other modules.
-        R.setPassName(ORE->PassName);
-        ORE->emit(R);
+        r.setPassName(emitter->passName);
+        emitter->emit(r);
       }
     }
   }
@@ -195,10 +206,10 @@ class Emitter {
   OptRemark::Emitter::emitOrDebug(DEBUG_TYPE, __VA_ARGS__)
 
 template <> inline bool Emitter::isEnabled<RemarkMissed>() {
-  return MissedEnabled;
+  return missedEnabled;
 }
 template <> inline bool Emitter::isEnabled<RemarkPassed>() {
-  return PassedEnabled;
+  return passedEnabled;
 }
 } // namespace OptRemark
 } // namespace swift

include/swift/SIL/SILModule.h

@@ -67,6 +67,7 @@ class SILUndef;
 class SourceFile;
 class SerializedSILLoader;
 class SILFunctionBuilder;
+class SILRemarkStreamer;
 
 namespace Lowering {
 class SILGenModule;
@@ -232,13 +233,11 @@ class SILModule {
   // The list of SILProperties in the module.
   PropertyListType properties;
 
-  /// This is the underlying raw stream of OptRecordStream.
-  ///
-  /// It is also owned by SILModule in order to keep their lifetime in sync.
-  std::unique_ptr<llvm::raw_ostream> OptRecordRawStream;
+  /// The remark output stream used to record SIL remarks to a file.
+  std::unique_ptr<llvm::raw_fd_ostream> silRemarkStream;
 
-  /// If non-null, the YAML file where remarks should be recorded.
-  std::unique_ptr<llvm::yaml::Output> OptRecordStream;
+  /// The remark streamer used to serialize SIL remarks to a file.
+  std::unique_ptr<swift::SILRemarkStreamer> silRemarkStreamer;
 
   /// This is a cache of intrinsic Function declarations to numeric ID mappings.
   llvm::DenseMap<Identifier, IntrinsicInfo> IntrinsicIDCache;
@@ -524,9 +523,12 @@ class SILModule {
     return coverageMaps;
   }
 
-  llvm::yaml::Output *getOptRecordStream() { return OptRecordStream.get(); }
-  void setOptRecordStream(std::unique_ptr<llvm::yaml::Output> &&Stream,
-                          std::unique_ptr<llvm::raw_ostream> &&RawStream);
+  swift::SILRemarkStreamer *getSILRemarkStreamer() {
+    return silRemarkStreamer.get();
+  }
+  void setSILRemarkStreamer(
+      std::unique_ptr<llvm::raw_fd_ostream> &&remarkStream,
+      std::unique_ptr<swift::SILRemarkStreamer> &&remarkStreamer);
 
   // This is currently limited to VarDecl because the visibility of global
   // variables and class properties is straightforward, while the visibility of