91 lines
		
	
	
		
			3.0 KiB
		
	
	
	
		
			C++
		
	
	
	
			
		
		
	
	
			91 lines
		
	
	
		
			3.0 KiB
		
	
	
	
		
			C++
		
	
	
	
//===--------------------- SummaryView.h ------------------------*- C++ -*-===//
 | 
						|
//
 | 
						|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 | 
						|
// See https://llvm.org/LICENSE.txt for license information.
 | 
						|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 | 
						|
//
 | 
						|
//===----------------------------------------------------------------------===//
 | 
						|
/// \file
 | 
						|
///
 | 
						|
/// This file implements the summary view.
 | 
						|
///
 | 
						|
/// The goal of the summary view is to give a very quick overview of the
 | 
						|
/// performance throughput. Below is an example of summary view:
 | 
						|
///
 | 
						|
///
 | 
						|
/// Iterations:        300
 | 
						|
/// Instructions:      900
 | 
						|
/// Total Cycles:      610
 | 
						|
/// Dispatch Width:    2
 | 
						|
/// IPC:               1.48
 | 
						|
/// Block RThroughput: 2.0
 | 
						|
///
 | 
						|
/// The summary view collects a few performance numbers. The two main
 | 
						|
/// performance indicators are 'Total Cycles' and IPC (Instructions Per Cycle).
 | 
						|
///
 | 
						|
//===----------------------------------------------------------------------===//
 | 
						|
 | 
						|
#ifndef LLVM_TOOLS_LLVM_MCA_SUMMARYVIEW_H
 | 
						|
#define LLVM_TOOLS_LLVM_MCA_SUMMARYVIEW_H
 | 
						|
 | 
						|
#include "llvm/ADT/DenseMap.h"
 | 
						|
#include "llvm/MC/MCSchedule.h"
 | 
						|
#include "llvm/MCA/View.h"
 | 
						|
#include "llvm/Support/raw_ostream.h"
 | 
						|
 | 
						|
namespace llvm {
 | 
						|
namespace mca {
 | 
						|
 | 
						|
/// A view that collects and prints a few performance numbers.
 | 
						|
class SummaryView : public View {
 | 
						|
  const llvm::MCSchedModel &SM;
 | 
						|
  llvm::ArrayRef<llvm::MCInst> Source;
 | 
						|
  const unsigned DispatchWidth;
 | 
						|
  unsigned LastInstructionIdx;
 | 
						|
  unsigned TotalCycles;
 | 
						|
  // The total number of micro opcodes contributed by a block of instructions.
 | 
						|
  unsigned NumMicroOps;
 | 
						|
 | 
						|
  struct DisplayValues {
 | 
						|
    unsigned Instructions;
 | 
						|
    unsigned Iterations;
 | 
						|
    unsigned TotalInstructions;
 | 
						|
    unsigned TotalCycles;
 | 
						|
    unsigned DispatchWidth;
 | 
						|
    unsigned TotalUOps;
 | 
						|
    double IPC;
 | 
						|
    double UOpsPerCycle;
 | 
						|
    double BlockRThroughput;
 | 
						|
  };
 | 
						|
 | 
						|
  // For each processor resource, this vector stores the cumulative number of
 | 
						|
  // resource cycles consumed by the analyzed code block.
 | 
						|
  llvm::SmallVector<unsigned, 8> ProcResourceUsage;
 | 
						|
 | 
						|
  // Each processor resource is associated with a so-called processor resource
 | 
						|
  // mask. This vector allows to correlate processor resource IDs with processor
 | 
						|
  // resource masks. There is exactly one element per each processor resource
 | 
						|
  // declared by the scheduling model.
 | 
						|
  llvm::SmallVector<uint64_t, 8> ProcResourceMasks;
 | 
						|
 | 
						|
  // Used to map resource indices to actual processor resource IDs.
 | 
						|
  llvm::SmallVector<unsigned, 8> ResIdx2ProcResID;
 | 
						|
 | 
						|
  /// Compute the data we want to print out in the object DV.
 | 
						|
  void collectData(DisplayValues &DV) const;
 | 
						|
 | 
						|
public:
 | 
						|
  SummaryView(const llvm::MCSchedModel &Model, llvm::ArrayRef<llvm::MCInst> S,
 | 
						|
              unsigned Width);
 | 
						|
 | 
						|
  void onCycleEnd() override { ++TotalCycles; }
 | 
						|
  void onEvent(const HWInstructionEvent &Event) override;
 | 
						|
  void printView(llvm::raw_ostream &OS) const override;
 | 
						|
  StringRef getNameAsString() const override { return "SummaryView"; }
 | 
						|
  json::Value toJSON() const override;
 | 
						|
};
 | 
						|
} // namespace mca
 | 
						|
} // namespace llvm
 | 
						|
 | 
						|
#endif
 |