llvm/tools/llvm-exegesis/lib/Analysis.h

   1 //===-- Analysis.h ----------------------------------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 ///
   9 /// \file
  10 /// Analysis output for benchmark results.
  11 ///
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TOOLS_LLVM_EXEGESIS_ANALYSIS_H
  15 #define LLVM_TOOLS_LLVM_EXEGESIS_ANALYSIS_H
  16
  17 #include "Clustering.h"
  18 #include "DisassemblerHelper.h"
  19 #include "SchedClassResolution.h"
  20 #include "llvm/MC/MCInstrInfo.h"
  21 #include "llvm/MC/MCObjectFileInfo.h"
  22 #include "llvm/MC/MCSubtargetInfo.h"
  23 #include "llvm/Support/Error.h"
  24 #include "llvm/Support/raw_ostream.h"
  25 #include <memory>
  26 #include <set>
  27 #include <string>
  28 #include <unordered_map>
  29
  30 namespace llvm {
  31 namespace exegesis {
  32
  33 // A helper class to analyze benchmark results for a target.
  34 class Analysis {
  35 public:
  36   Analysis(const LLVMState &State,
  37            const BenchmarkClustering &Clustering,
  38            double AnalysisInconsistencyEpsilon,
  39            bool AnalysisDisplayUnstableOpcodes);
  40
  41   // Prints a csv of instructions for each cluster.
  42   struct PrintClusters {};
  43   // Find potential errors in the scheduling information given measurements.
  44   struct PrintSchedClassInconsistencies {};
  45
  46   template <typename Pass> Error run(raw_ostream &OS) const;
  47
  48 private:
  49   using ClusterId = BenchmarkClustering::ClusterId;
  50
  51   // Represents the intersection of a sched class and a cluster.
  52   class SchedClassCluster {
  53   public:
  54     const BenchmarkClustering::ClusterId &id() const {
  55       return ClusterId;
  56     }
  57
  58     const std::vector<size_t> &getPointIds() const { return PointIds; }
  59
  60     void addPoint(size_t PointId,
  61                   const BenchmarkClustering &Clustering);
  62
  63     // Return the cluster centroid.
  64     const SchedClassClusterCentroid &getCentroid() const { return Centroid; }
  65
  66     // Returns true if the cluster representative measurements match that of SC.
  67     bool
  68     measurementsMatch(const MCSubtargetInfo &STI, const ResolvedSchedClass &SC,
  69                       const BenchmarkClustering &Clustering,
  70                       const double AnalysisInconsistencyEpsilonSquared_) const;
  71
  72   private:
  73     BenchmarkClustering::ClusterId ClusterId;
  74     std::vector<size_t> PointIds;
  75     // Measurement stats for the points in the SchedClassCluster.
  76     SchedClassClusterCentroid Centroid;
  77   };
  78
  79   void printInstructionRowCsv(size_t PointId, raw_ostream &OS) const;
  80
  81   void printClusterRawHtml(const BenchmarkClustering::ClusterId &Id,
  82                            StringRef display_name, llvm::raw_ostream &OS) const;
  83
  84   void printPointHtml(const Benchmark &Point,
  85                       llvm::raw_ostream &OS) const;
  86
  87   void
  88   printSchedClassClustersHtml(const std::vector<SchedClassCluster> &Clusters,
  89                               const ResolvedSchedClass &SC,
  90                               raw_ostream &OS) const;
  91   void printSchedClassDescHtml(const ResolvedSchedClass &SC,
  92                                raw_ostream &OS) const;
  93
  94   // A pair of (Sched Class, indices of points that belong to the sched
  95   // class).
  96   struct ResolvedSchedClassAndPoints {
  97     explicit ResolvedSchedClassAndPoints(ResolvedSchedClass &&RSC);
  98
  99     ResolvedSchedClass RSC;
 100     std::vector<size_t> PointIds;
 101   };
 102
 103   // Builds a list of ResolvedSchedClassAndPoints.
 104   std::vector<ResolvedSchedClassAndPoints> makePointsPerSchedClass() const;
 105
 106   template <typename EscapeTag, EscapeTag Tag>
 107   void writeSnippet(raw_ostream &OS, ArrayRef<uint8_t> Bytes,
 108                     const char *Separator) const;
 109
 110   const BenchmarkClustering &Clustering_;
 111   const LLVMState &State_;
 112   std::unique_ptr<DisassemblerHelper> DisasmHelper_;
 113   const double AnalysisInconsistencyEpsilonSquared_;
 114   const bool AnalysisDisplayUnstableOpcodes_;
 115 };
 116
 117 } // namespace exegesis
 118 } // namespace llvm
 119
 120 #endif // LLVM_TOOLS_LLVM_EXEGESIS_CLUSTERING_H