[llvm-exegesis] Analysis output uses HTML.

[courbet]

Summary

This makes the report much more readable.

[courbet]

Sample output:

inconsistencies.html68 KBDownload

[lebedev.ri]

tools/llvm-exegesis/lib/Analysis.cpp

28

This should take StringRef, not std::string

45

This should take StringRef, not std::string

[courbet]

• Pass parameters by StringRef instead of sts::string

[gchatelet]

It might be worth splitting this file if it becomes too big.

tools/llvm-exegesis/lib/Clustering.cpp

172

Can we try to leverage std::tie here?

const bool IsValid = isValid();
const bool OtherIsValid = Other.isValid();
return std::tie(IsValid, Id) < std::tie(OtherIsValid, Other.Id);

[courbet]

• Pick private constants to make ordering trivial.

[courbet]

In D47189#1107755, @gchatelet wrote:

It might be worth splitting this file if it becomes too big.

I think 300 lines is still OK :D

tools/llvm-exegesis/lib/Clustering.cpp

172

I've made the ordering simpler.

tools/llvm-exegesis/lib/Analysis.h

public:
   // Prints a csv of instructions for each cluster.
   struct PrintClusters {};
   // Find potential errors in the scheduling information given measurements.
   struct PrintSchedClassInconsistencies {};
 
   template <typename Pass> llvm::Error run(llvm::raw_ostream &OS) const;
 
 private:
-  void printInstructionRow(bool PrintSchedClass, size_t PointId,
+  void printInstructionRowCsv(size_t PointId, llvm::raw_ostream &OS) const;
+
+  void printSchedClassHtml(std::vector<size_t> PointIds,
                            llvm::raw_ostream &OS) const;
 
   // Builds a map of Sched Class -> indices of points that belong to the sched
   // class.
   std::unordered_map<unsigned, std::vector<size_t>>
   makePointsPerSchedClass() const;
 
   const InstructionBenchmarkClustering &Clustering_;
   std::unique_ptr<llvm::MCSubtargetInfo> SubtargetInfo_;
   std::unique_ptr<llvm::MCInstrInfo> InstrInfo_;
   std::unordered_map<std::string, unsigned> MnemonicToOpcode_;
 };
 
 } // namespace exegesis
 
 #endif // LLVM_TOOLS_LLVM_EXEGESIS_CLUSTERING_H

tools/llvm-exegesis/lib/Analysis.cpp

 #include "llvm/Support/FormatVariadic.h"
 #include <unordered_set>
 #include <vector>
 
 namespace exegesis {
 
 static const char kCsvSep = ',';
 
-static void writeCsvEscaped(llvm::raw_ostream &OS, const std::string &S) {
+namespace {
+
+enum EscapeTag { kEscapeCsv, kEscapeHtml };
+
+template <EscapeTag Tag>
+void writeEscaped(llvm::raw_ostream &OS, const llvm::StringRef S);
+
+template <>
+void writeEscaped<kEscapeCsv>(llvm::raw_ostream &OS, const llvm::StringRef S) {
   if (std::find(S.begin(), S.end(), kCsvSep) == S.end()) {
     OS << S;
   } else {
     // Needs escaping.
     OS << '"';
     for (const char C : S) {
       if (C == '"')
         OS << "\"\"";
       else
         OS << C;
     }
     OS << '"';
   }
 }
 
+template <>
+void writeEscaped<kEscapeHtml>(llvm::raw_ostream &OS, const llvm::StringRef S) {
+  for (const char C : S) {
+    if (C == '<')
+      OS << "&lt;";
+    else if (C == '>')
+      OS << "&gt;";
+    else if (C == '&')
+      OS << "&amp;";
+    else
+      OS << C;
+  }
+}
+
+} // namespace
+
+template <EscapeTag Tag>
+static void
+writeClusterId(llvm::raw_ostream &OS,
+               const InstructionBenchmarkClustering::ClusterId &CID) {
+  if (CID.isNoise())
+    writeEscaped<Tag>(OS, "[noise]");
+  else if (CID.isError())
+    writeEscaped<Tag>(OS, "[error]");
+  else
+    OS << CID.getId();
+}
+
+template <EscapeTag Tag>
+static void writeMeasurementValue(llvm::raw_ostream &OS, const double Value) {
+  writeEscaped<Tag>(OS, llvm::formatv("{0:F}", Value).str());
+}
+
 // Prints a row representing an instruction, along with scheduling info and
 // point coordinates (measurements).
-void Analysis::printInstructionRow(const bool PrintSchedClass,
-                                   const size_t PointId,
+void Analysis::printInstructionRowCsv(const size_t PointId,
                                       llvm::raw_ostream &OS) const {
   const InstructionBenchmark &Point = Clustering_.getPoints()[PointId];
-  const auto &ClusterId = Clustering_.getClusterIdForPoint(PointId);
-  if (ClusterId.isNoise())
-    OS << "[noise]";
-  else if (ClusterId.isError())
-    OS << "[error]";
-  else
-    OS << ClusterId.getId();
+  writeClusterId<kEscapeCsv>(OS, Clustering_.getClusterIdForPoint(PointId));
   OS << kCsvSep;
-  writeCsvEscaped(OS, Point.Key.OpcodeName);
+  writeEscaped<kEscapeCsv>(OS, Point.Key.OpcodeName);
   OS << kCsvSep;
-  writeCsvEscaped(OS, Point.Key.Config);
-  if (PrintSchedClass) {
-    OS << kCsvSep;
-    const auto OpcodeIt = MnemonicToOpcode_.find(Point.Key.OpcodeName);
-    if (OpcodeIt != MnemonicToOpcode_.end()) {
-      const unsigned SchedClassId =
-          InstrInfo_->get(OpcodeIt->second).getSchedClass();
+  writeEscaped<kEscapeCsv>(OS, Point.Key.Config);
 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
-      const auto &SchedModel = SubtargetInfo_->getSchedModel();
-      const llvm::MCSchedClassDesc *const SCDesc =
-          SchedModel.getSchedClassDesc(SchedClassId);
-      writeCsvEscaped(OS, SCDesc->Name);
+    writeEscaped<kEscapeCsv>(OS, SCDesc->Name);
 #else
-      OS << SchedClassId;
 #endif
-    }
-  }
   // FIXME: Print the sched class once InstructionBenchmark separates key into
   // (mnemonic, mode, opaque).
   for (const auto &Measurement : Point.Measurements) {
     OS << kCsvSep;
-    writeCsvEscaped(OS, llvm::formatv("{0:F}", Measurement.Value));
+    writeMeasurementValue<kEscapeCsv>(OS, Measurement.Value);
   }
   OS << "\n";
 }
 
 Analysis::Analysis(const llvm::Target &Target,
                    const InstructionBenchmarkClustering &Clustering)
     : Clustering_(Clustering) {
   if (Clustering.getPoints().empty())
Analysis::run<Analysis::PrintClusters>(llvm::raw_ostream &OS) const {
   if (Clustering_.getPoints().empty())
     return llvm::Error::success();
 
   // Write the header.
   OS << "cluster_id" << kCsvSep << "opcode_name" << kCsvSep << "config"
      << kCsvSep << "sched_class";
   for (const auto &Measurement : Clustering_.getPoints().front().Measurements) {
     OS << kCsvSep;
-    writeCsvEscaped(OS, Measurement.Key);
+    writeEscaped<kEscapeCsv>(OS, Measurement.Key);
   }
   OS << "\n";
 
   // Write the points.
   const auto &Clusters = Clustering_.getValidClusters();
   for (size_t I = 0, E = Clusters.size(); I < E; ++I) {
     for (const size_t PointId : Clusters[I].PointIndices) {
-      printInstructionRow(/*PrintSchedClass*/ true, PointId, OS);
+      printInstructionRowCsv(PointId, OS);
     }
     OS << "\n\n";
   }
   return llvm::Error::success();
 }
 
 std::unordered_map<unsigned, std::vector<size_t>>
 Analysis::makePointsPerSchedClass() const {
   std::unordered_map<unsigned, std::vector<size_t>> PointsPerSchedClass;
   const auto &Points = Clustering_.getPoints();
   for (size_t PointId = 0, E = Points.size(); PointId < E; ++PointId) {
     const InstructionBenchmark &Point = Points[PointId];
     if (!Point.Error.empty())
       continue;
     const auto OpcodeIt = MnemonicToOpcode_.find(Point.Key.OpcodeName);
     if (OpcodeIt == MnemonicToOpcode_.end())
       continue;
     const unsigned SchedClassId =
         InstrInfo_->get(OpcodeIt->second).getSchedClass();
     PointsPerSchedClass[SchedClassId].push_back(PointId);
   }
   return PointsPerSchedClass;
 }
 
+void Analysis::printSchedClassHtml(std::vector<size_t> PointIds,
+                                   llvm::raw_ostream &OS) const {
+  assert(!PointIds.empty());
+  // Sort the points by cluster id so that we can display them grouped by
+  // cluster.
+  std::sort(PointIds.begin(), PointIds.end(),
+            [this](const size_t A, const size_t B) {
+              return Clustering_.getClusterIdForPoint(A) <
+                     Clustering_.getClusterIdForPoint(B);
+            });
+  const auto &Points = Clustering_.getPoints();
+  OS << "<table class=\"sched-class\">";
+  OS << "<tr><th>ClusterId</th><th>Opcode/Config</th>";
+  for (const auto &Measurement : Points[PointIds[0]].Measurements) {
+    OS << "<th>";
+    writeEscaped<kEscapeHtml>(OS, Measurement.Key);
+    OS << "</th>";
+  }
+  OS << "</tr>";
+  for (size_t I = 0, E = PointIds.size(); I < E;) {
+    const auto &CurrentClusterId =
+        Clustering_.getClusterIdForPoint(PointIds[I]);
+    OS << "<tr><td>";
+    writeClusterId<kEscapeHtml>(OS, CurrentClusterId);
+    OS << "</td><td><ul>";
+    const auto &ClusterRepresentative =
+        Points[PointIds[I]]; // FIXME: average measurements.
+    for (; I < E &&
+           Clustering_.getClusterIdForPoint(PointIds[I]) == CurrentClusterId;
+         ++I) {
+      OS << "<li><span class=\"mono\">";
+      writeEscaped<kEscapeHtml>(OS, Points[PointIds[I]].Key.OpcodeName);
+      OS << "</span> <span class=\"mono\">";
+      writeEscaped<kEscapeHtml>(OS, Points[PointIds[I]].Key.Config);
+      OS << "</span></li>";
+    }
+    OS << "</ul></td>";
+    for (const auto &Measurement : ClusterRepresentative.Measurements) {
+      OS << "<td>";
+      writeMeasurementValue<kEscapeHtml>(OS, Measurement.Value);
+      OS << "</td>";
+    }
+    OS << "</tr>";
+  }
+  OS << "</table>";
+}
+
+static constexpr const char kHtmlHead[] = R"(
+<head>
+<title>llvm-exegesis Analysis Results</title>
+<style>
+body {
+  font-family: sans-serif
+}
+span.sched-class-name {
+  font-weight: bold;
+  font-family: monospace;
+}
+span.opcode {
+  font-family: monospace;
+}
+span.config {
+  font-family: monospace;
+}
+div.inconsistency {
+  margin-top: 50px;
+}
+table.sched-class {
+  margin-left: 50px;
+  border-collapse: collapse;
+}
+table.sched-class, table.sched-class tr,td,th {
+  border: 1px solid #444;
+}
+table.sched-class td {
+  padding-left: 10px;
+  padding-right: 10px;
+  padding-top: 10px;
+  padding-bottom: 10px;
+}
+table.sched-class ul {
+  padding-left: 0px;
+  margin: 0px;
+  list-style-type: none;
+}
+span.mono {
+  font-family: monospace;
+}
+</style>
+</head>
+)";
+
 template <>
 llvm::Error Analysis::run<Analysis::PrintSchedClassInconsistencies>(
     llvm::raw_ostream &OS) const {
+  // Print the header.
+  OS << "<!DOCTYPE html><html>" << kHtmlHead << "<body>";
+  OS << "<h1><span class=\"mono\">llvm-exegesis</span> Analysis Results</h1>";
+  OS << "<h3>Triple: <span class=\"mono\">";
+  writeEscaped<kEscapeHtml>(OS, Clustering_.getPoints()[0].LLVMTriple);
+  OS << "</span></h3><h3>Cpu: <span class=\"mono\">";
+  writeEscaped<kEscapeHtml>(OS, Clustering_.getPoints()[0].CpuName);
+  OS << "</span></h3>";
+
   // All the points in a scheduling class should be in the same cluster.
   // Print any scheduling class for which this is not the case.
   for (const auto &SchedClassAndPoints : makePointsPerSchedClass()) {
     std::unordered_set<size_t> ClustersForSchedClass;
     for (const size_t PointId : SchedClassAndPoints.second) {
       const auto &ClusterId = Clustering_.getClusterIdForPoint(PointId);
       if (!ClusterId.isValid())
         continue; // Ignore noise and errors.
       ClustersForSchedClass.insert(ClusterId.getId());
     }
     if (ClustersForSchedClass.size() <= 1)
       continue; // Nothing weird.
 
-    OS << "\nSched Class ";
+    OS << "<div class=\"inconsistency\"><p>Sched Class <span "
+          "class=\"sched-class-name\">";
 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
     const auto &SchedModel = SubtargetInfo_->getSchedModel();
     const llvm::MCSchedClassDesc *const SCDesc =
         SchedModel.getSchedClassDesc(SchedClassAndPoints.first);
-    OS << SCDesc->Name;
+    writeEscaped<kEscapeHtml>(OS, SCDesc->Name);
 #else
     OS << SchedClassAndPoints.first;
 #endif
-    OS << " contains instructions with distinct performance "
+    OS << "</span> contains instructions with distinct performance "
           "characteristics, falling into "
-       << ClustersForSchedClass.size() << " clusters:\n";
-    for (const size_t PointId : SchedClassAndPoints.second) {
-      printInstructionRow(/*PrintSchedClass*/ false, PointId, OS);
-    }
+       << ClustersForSchedClass.size() << " clusters:</p>";
+    printSchedClassHtml(SchedClassAndPoints.second, OS);
+    OS << "</div>";
   }
+
+  OS << "</body></html>";
   return llvm::Error::success();
 }
 
 } // namespace exegesis

tools/llvm-exegesis/lib/Clustering.h

public:
     static ClusterId noise() { return ClusterId(kNoise); }
     static ClusterId error() { return ClusterId(kError); }
     static ClusterId makeValid(int Id) {
       assert(Id >= 0);
       return ClusterId(Id);
     }
     ClusterId() : Id_(kUndef) {}
     bool operator==(const ClusterId &O) const { return Id_ == O.Id_; }
+    bool operator<(const ClusterId &Other) const;
 
     bool isValid() const { return Id_ >= 0; }
     bool isUndef() const { return Id_ == kUndef; }
     bool isNoise() const { return Id_ == kNoise; }
     bool isError() const { return Id_ == kError; }
 
     // Precondition: isValid().
     size_t getId() const {

tools/llvm-exegesis/lib/Clustering.cpp

InstructionBenchmarkClustering::create(
   if (Clustering.ErrorCluster_.PointIndices.size() == Points.size()) {
     return Clustering; // Nothing to cluster.
   }
 
   Clustering.dbScan(MinPts, Epsilon * Epsilon);
   return Clustering;
 }
 
+bool InstructionBenchmarkClustering::ClusterId::
+operator<(const ClusterId &Other) const {
+  if (isValid()) {
+    if (Other.isValid()) {
+      return getId() < Other.getId();
+    }
+    return true;
+  }
+  if (Other.isValid()) {
+    return false;
+  }
+  return Other.Id_ < Id_;
+}
+
 } // namespace exegesis

unittests/tools/llvm-exegesis/ClusteringTest.cpp

TEST(ClusteringTest, Clusters3D_InvalidOrder) {
   Points[0].Measurements = {{"x", 0.01, ""}, {"y", 1.02, ""}};
   Points[1].Measurements = {{"y", 1.02, ""}, {"x", 1.98, ""}};
   auto Error =
       InstructionBenchmarkClustering::create(Points, 2, 0.25).takeError();
   ASSERT_TRUE((bool)Error);
   consumeError(std::move(Error));
 }
 
+TEST(ClusteringTest, Ordering) {
+  ASSERT_LT(InstructionBenchmarkClustering::ClusterId::makeValid(1),
+            InstructionBenchmarkClustering::ClusterId::makeValid(2));
+
+  ASSERT_LT(InstructionBenchmarkClustering::ClusterId::makeValid(2),
+            InstructionBenchmarkClustering::ClusterId::noise());
+
+  ASSERT_LT(InstructionBenchmarkClustering::ClusterId::makeValid(2),
+            InstructionBenchmarkClustering::ClusterId::error());
+
+  ASSERT_LT(InstructionBenchmarkClustering::ClusterId::noise(),
+            InstructionBenchmarkClustering::ClusterId::error());
+}
+
 } // namespace
 } // namespace exegesis