5f8f34e459
We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done Differential Revision: https://reviews.llvm.org/D46290 llvm-svn: 331272
55 lines
1.5 KiB
C++
55 lines
1.5 KiB
C++
//===--------------------- SummaryView.h ---------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
/// \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
|
|
///
|
|
///
|
|
/// 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 "SourceMgr.h"
|
|
#include "View.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
namespace mca {
|
|
|
|
/// A view that collects and prints a few performance numbers.
|
|
class SummaryView : public View {
|
|
const SourceMgr &Source;
|
|
const unsigned DispatchWidth;
|
|
unsigned TotalCycles;
|
|
|
|
public:
|
|
SummaryView(const SourceMgr &S, unsigned Width)
|
|
: Source(S), DispatchWidth(Width), TotalCycles(0) {}
|
|
|
|
void onCycleEnd() override { ++TotalCycles; }
|
|
|
|
void printView(llvm::raw_ostream &OS) const override;
|
|
};
|
|
} // namespace mca
|
|
|
|
#endif
|