Clement Courbet | 37f0ca0 | 2018-05-15 12:08:00 +0000 | [diff] [blame] | 1 | //===-- Analysis.h ----------------------------------------------*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | /// |
| 10 | /// \file |
| 11 | /// Analysis output for benchmark results. |
| 12 | /// |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
| 15 | #ifndef LLVM_TOOLS_LLVM_EXEGESIS_ANALYSIS_H |
| 16 | #define LLVM_TOOLS_LLVM_EXEGESIS_ANALYSIS_H |
| 17 | |
| 18 | #include "Clustering.h" |
Clement Courbet | 4273e1e | 2018-06-15 07:30:45 +0000 | [diff] [blame] | 19 | #include "llvm/MC/MCContext.h" |
| 20 | #include "llvm/MC/MCDisassembler/MCDisassembler.h" |
| 21 | #include "llvm/MC/MCInstPrinter.h" |
Clement Courbet | 6d6c1a9 | 2018-05-16 08:47:21 +0000 | [diff] [blame] | 22 | #include "llvm/MC/MCInstrInfo.h" |
Clement Courbet | 4273e1e | 2018-06-15 07:30:45 +0000 | [diff] [blame] | 23 | #include "llvm/MC/MCObjectFileInfo.h" |
Clement Courbet | 37f0ca0 | 2018-05-15 12:08:00 +0000 | [diff] [blame] | 24 | #include "llvm/MC/MCSubtargetInfo.h" |
| 25 | #include "llvm/Support/Error.h" |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 26 | #include "llvm/Support/TargetRegistry.h" |
Clement Courbet | 37f0ca0 | 2018-05-15 12:08:00 +0000 | [diff] [blame] | 27 | #include "llvm/Support/raw_ostream.h" |
Clement Courbet | 4273e1e | 2018-06-15 07:30:45 +0000 | [diff] [blame] | 28 | #include <memory> |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 29 | #include <set> |
Clement Courbet | 6d6c1a9 | 2018-05-16 08:47:21 +0000 | [diff] [blame] | 30 | #include <string> |
| 31 | #include <unordered_map> |
Clement Courbet | 37f0ca0 | 2018-05-15 12:08:00 +0000 | [diff] [blame] | 32 | |
| 33 | namespace exegesis { |
| 34 | |
Clement Courbet | 6d6c1a9 | 2018-05-16 08:47:21 +0000 | [diff] [blame] | 35 | // A helper class to analyze benchmark results for a target. |
| 36 | class Analysis { |
| 37 | public: |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 38 | Analysis(const llvm::Target &Target, |
| 39 | const InstructionBenchmarkClustering &Clustering); |
Clement Courbet | 6d6c1a9 | 2018-05-16 08:47:21 +0000 | [diff] [blame] | 40 | |
| 41 | // Prints a csv of instructions for each cluster. |
Clement Courbet | cf21074 | 2018-05-17 13:41:28 +0000 | [diff] [blame] | 42 | struct PrintClusters {}; |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 43 | // Find potential errors in the scheduling information given measurements. |
Clement Courbet | cf21074 | 2018-05-17 13:41:28 +0000 | [diff] [blame] | 44 | struct PrintSchedClassInconsistencies {}; |
| 45 | |
| 46 | template <typename Pass> llvm::Error run(llvm::raw_ostream &OS) const; |
Clement Courbet | 6d6c1a9 | 2018-05-16 08:47:21 +0000 | [diff] [blame] | 47 | |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 48 | private: |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 49 | using ClusterId = InstructionBenchmarkClustering::ClusterId; |
| 50 | |
| 51 | // An llvm::MCSchedClassDesc augmented with some additional data. |
Clement Courbet | d5a3955 | 2018-10-03 11:50:25 +0000 | [diff] [blame^] | 52 | struct ResolvedSchedClass { |
| 53 | ResolvedSchedClass(const llvm::MCSubtargetInfo &STI, |
| 54 | unsigned ResolvedSchedClassId, bool WasVariant); |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 55 | |
Clement Courbet | 4273e1e | 2018-06-15 07:30:45 +0000 | [diff] [blame] | 56 | const llvm::MCSchedClassDesc *const SCDesc; |
Clement Courbet | d5a3955 | 2018-10-03 11:50:25 +0000 | [diff] [blame^] | 57 | const bool WasVariant; // Whether the original class was variant. |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 58 | const llvm::SmallVector<llvm::MCWriteProcResEntry, 8> |
| 59 | NonRedundantWriteProcRes; |
| 60 | const std::vector<std::pair<uint16_t, float>> IdealizedProcResPressure; |
| 61 | }; |
| 62 | |
| 63 | // Represents the intersection of a sched class and a cluster. |
| 64 | class SchedClassCluster { |
| 65 | public: |
| 66 | const InstructionBenchmarkClustering::ClusterId &id() const { |
| 67 | return ClusterId; |
| 68 | } |
| 69 | |
| 70 | const std::vector<size_t> &getPointIds() const { return PointIds; } |
| 71 | |
| 72 | // Return the cluster centroid. |
Clement Courbet | 684a5f6 | 2018-09-26 08:37:21 +0000 | [diff] [blame] | 73 | const std::vector<PerInstructionStats> &getRepresentative() const { |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 74 | return Representative; |
| 75 | } |
| 76 | |
| 77 | // Returns true if the cluster representative measurements match that of SC. |
| 78 | bool |
Clement Courbet | d5a3955 | 2018-10-03 11:50:25 +0000 | [diff] [blame^] | 79 | measurementsMatch(const llvm::MCSubtargetInfo &STI, |
| 80 | const ResolvedSchedClass &SC, |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 81 | const InstructionBenchmarkClustering &Clustering) const; |
| 82 | |
| 83 | void addPoint(size_t PointId, |
| 84 | const InstructionBenchmarkClustering &Clustering); |
| 85 | |
| 86 | private: |
| 87 | InstructionBenchmarkClustering::ClusterId ClusterId; |
| 88 | std::vector<size_t> PointIds; |
| 89 | // Measurement stats for the points in the SchedClassCluster. |
Clement Courbet | 684a5f6 | 2018-09-26 08:37:21 +0000 | [diff] [blame] | 90 | std::vector<PerInstructionStats> Representative; |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 91 | }; |
| 92 | |
Clement Courbet | 17d3c25 | 2018-05-22 13:31:29 +0000 | [diff] [blame] | 93 | void printInstructionRowCsv(size_t PointId, llvm::raw_ostream &OS) const; |
| 94 | |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 95 | void |
| 96 | printSchedClassClustersHtml(const std::vector<SchedClassCluster> &Clusters, |
Clement Courbet | d5a3955 | 2018-10-03 11:50:25 +0000 | [diff] [blame^] | 97 | const ResolvedSchedClass &SC, |
Clement Courbet | 7228721 | 2018-06-04 11:11:55 +0000 | [diff] [blame] | 98 | llvm::raw_ostream &OS) const; |
Clement Courbet | d5a3955 | 2018-10-03 11:50:25 +0000 | [diff] [blame^] | 99 | void printSchedClassDescHtml(const ResolvedSchedClass &SC, |
Clement Courbet | 2637e5f | 2018-05-24 10:47:05 +0000 | [diff] [blame] | 100 | llvm::raw_ostream &OS) const; |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 101 | |
Clement Courbet | d5a3955 | 2018-10-03 11:50:25 +0000 | [diff] [blame^] | 102 | // A pair of (Sched Class, indices of points that belong to the sched |
| 103 | // class). |
| 104 | struct ResolvedSchedClassAndPoints { |
| 105 | explicit ResolvedSchedClassAndPoints(ResolvedSchedClass &&RSC); |
| 106 | |
| 107 | ResolvedSchedClass RSC; |
| 108 | std::vector<size_t> PointIds; |
| 109 | }; |
| 110 | |
| 111 | // Builds a list of ResolvedSchedClassAndPoints. |
| 112 | std::vector<ResolvedSchedClassAndPoints> makePointsPerSchedClass() const; |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 113 | |
Clement Courbet | 4273e1e | 2018-06-15 07:30:45 +0000 | [diff] [blame] | 114 | template <typename EscapeTag, EscapeTag Tag> |
| 115 | void writeSnippet(llvm::raw_ostream &OS, llvm::ArrayRef<uint8_t> Bytes, |
| 116 | const char *Separator) const; |
| 117 | |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 118 | const InstructionBenchmarkClustering &Clustering_; |
Clement Courbet | 4273e1e | 2018-06-15 07:30:45 +0000 | [diff] [blame] | 119 | llvm::MCObjectFileInfo ObjectFileInfo_; |
| 120 | std::unique_ptr<llvm::MCContext> Context_; |
Clement Courbet | 448550d | 2018-05-17 12:25:18 +0000 | [diff] [blame] | 121 | std::unique_ptr<llvm::MCSubtargetInfo> SubtargetInfo_; |
| 122 | std::unique_ptr<llvm::MCInstrInfo> InstrInfo_; |
Clement Courbet | 4273e1e | 2018-06-15 07:30:45 +0000 | [diff] [blame] | 123 | std::unique_ptr<llvm::MCRegisterInfo> RegInfo_; |
| 124 | std::unique_ptr<llvm::MCAsmInfo> AsmInfo_; |
| 125 | std::unique_ptr<llvm::MCInstPrinter> InstPrinter_; |
| 126 | std::unique_ptr<llvm::MCDisassembler> Disasm_; |
Clement Courbet | 6d6c1a9 | 2018-05-16 08:47:21 +0000 | [diff] [blame] | 127 | }; |
Clement Courbet | 37f0ca0 | 2018-05-15 12:08:00 +0000 | [diff] [blame] | 128 | |
Clement Courbet | df79e79 | 2018-06-01 14:18:02 +0000 | [diff] [blame] | 129 | // Computes the idealized ProcRes Unit pressure. This is the expected |
| 130 | // distribution if the CPU scheduler can distribute the load as evenly as |
| 131 | // possible. |
| 132 | std::vector<std::pair<uint16_t, float>> computeIdealizedProcResPressure( |
| 133 | const llvm::MCSchedModel &SM, |
| 134 | llvm::SmallVector<llvm::MCWriteProcResEntry, 8> WPRS); |
| 135 | |
Clement Courbet | 37f0ca0 | 2018-05-15 12:08:00 +0000 | [diff] [blame] | 136 | } // namespace exegesis |
| 137 | |
| 138 | #endif // LLVM_TOOLS_LLVM_EXEGESIS_CLUSTERING_H |