blob: e49d1cbe06377ee19e5fae846a7382fca4b9b419 [file] [log] [blame]
Chris Lattnerc758fe62002-10-01 22:35:45 +00001//===-- Statistic.cpp - Easy way to expose stats information --------------===//
Misha Brukman10468d82005-04-21 22:55:34 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman10468d82005-04-21 22:55:34 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner9eb00522002-05-10 15:36:46 +00009//
10// This file implements the 'Statistic' class, which is designed to be an easy
11// way to expose various success metrics from passes. These statistics are
12// printed at the end of a run, when the -stats command line option is enabled
13// on the command line.
14//
15// This is useful for reporting information like the number of instructions
16// simplified, optimized or removed by various transformations, like this:
17//
Chris Lattner8c9969a2006-12-08 20:00:42 +000018// static Statistic NumInstEliminated("GCSE", "Number of instructions killed");
Chris Lattner9eb00522002-05-10 15:36:46 +000019//
20// Later, in the code: ++NumInstEliminated;
21//
22//===----------------------------------------------------------------------===//
23
Reid Spencer7c16caa2004-09-01 22:55:40 +000024#include "llvm/ADT/Statistic.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000025#include "llvm/ADT/StringExtras.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000026#include "llvm/Support/CommandLine.h"
Peter Collingbourne4cfa0862015-08-18 22:31:24 +000027#include "llvm/Support/Compiler.h"
David Greeneb28b1ed2010-01-05 01:28:47 +000028#include "llvm/Support/Debug.h"
Benjamin Kramercc863b22011-10-16 16:30:34 +000029#include "llvm/Support/Format.h"
Chris Lattner8c9969a2006-12-08 20:00:42 +000030#include "llvm/Support/ManagedStatic.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000031#include "llvm/Support/Mutex.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000032#include "llvm/Support/raw_ostream.h"
Chris Lattnerafa3ec42003-08-13 21:32:37 +000033#include <algorithm>
Anton Korobeynikov579f0712008-02-20 11:08:44 +000034#include <cstring>
Chris Lattnerdd978ce2003-12-14 21:27:33 +000035using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000036
Chris Lattner8c9969a2006-12-08 20:00:42 +000037/// -stats - Command line option to cause transformations to emit stats about
38/// what they did.
39///
Chris Lattnerf5cad152002-07-22 02:10:13 +000040static cl::opt<bool>
Jan Wen Voung7857a642013-03-08 22:56:31 +000041Enabled(
42 "stats",
43 cl::desc("Enable statistics output from program (available with Asserts)"));
Chris Lattnerf5cad152002-07-22 02:10:13 +000044
Chris Lattnerc758fe62002-10-01 22:35:45 +000045
Chris Lattner8c9969a2006-12-08 20:00:42 +000046namespace {
47/// StatisticInfo - This class is used in a ManagedStatic so that it is created
Jim Grosbacha9277362010-08-17 17:37:22 +000048/// on demand (when the first statistic is bumped) and destroyed only when
Chris Lattner8c9969a2006-12-08 20:00:42 +000049/// llvm_shutdown is called. We print statistics from the destructor.
50class StatisticInfo {
Chris Lattner00bb2162006-12-19 23:17:40 +000051 std::vector<const Statistic*> Stats;
Douglas Gregor83fd0152010-03-30 17:32:08 +000052 friend void llvm::PrintStatistics();
53 friend void llvm::PrintStatistics(raw_ostream &OS);
Chris Lattner8c9969a2006-12-08 20:00:42 +000054public:
55 ~StatisticInfo();
Jim Grosbacha9277362010-08-17 17:37:22 +000056
Chris Lattner00bb2162006-12-19 23:17:40 +000057 void addStatistic(const Statistic *S) {
Chris Lattner8c9969a2006-12-08 20:00:42 +000058 Stats.push_back(S);
Chris Lattnerc758fe62002-10-01 22:35:45 +000059 }
Chris Lattner8c9969a2006-12-08 20:00:42 +000060};
Alexander Kornienkof00654e2015-06-23 09:49:53 +000061}
Chris Lattnerc758fe62002-10-01 22:35:45 +000062
Chris Lattner8c9969a2006-12-08 20:00:42 +000063static ManagedStatic<StatisticInfo> StatInfo;
Torok Edwin819d15c2009-09-27 11:08:03 +000064static ManagedStatic<sys::SmartMutex<true> > StatLock;
Chris Lattner8c9969a2006-12-08 20:00:42 +000065
66/// RegisterStatistic - The first time a statistic is bumped, this method is
67/// called.
Chris Lattner00bb2162006-12-19 23:17:40 +000068void Statistic::RegisterStatistic() {
Chris Lattner8c9969a2006-12-08 20:00:42 +000069 // If stats are enabled, inform StatInfo that this statistic should be
70 // printed.
Torok Edwin819d15c2009-09-27 11:08:03 +000071 sys::SmartScopedLock<true> Writer(*StatLock);
Owen Andersonca8f9862009-06-23 21:19:38 +000072 if (!Initialized) {
73 if (Enabled)
74 StatInfo->addStatistic(this);
Jim Grosbacha9277362010-08-17 17:37:22 +000075
Nick Lewycky897a57e2011-12-05 23:07:05 +000076 TsanHappensBefore(this);
Benjamin Kramer17388a62014-03-03 18:02:34 +000077 sys::MemoryFence();
Owen Andersonca8f9862009-06-23 21:19:38 +000078 // Remember we have been registered.
Nick Lewycky897a57e2011-12-05 23:07:05 +000079 TsanIgnoreWritesBegin();
Owen Andersonca8f9862009-06-23 21:19:38 +000080 Initialized = true;
Nick Lewycky897a57e2011-12-05 23:07:05 +000081 TsanIgnoreWritesEnd();
Owen Andersonca8f9862009-06-23 21:19:38 +000082 }
Chris Lattner8c9969a2006-12-08 20:00:42 +000083}
84
Sylvestre Ledru91ce36c2012-09-27 10:14:43 +000085// Print information when destroyed, iff command line option is specified.
Chris Lattner8c9969a2006-12-08 20:00:42 +000086StatisticInfo::~StatisticInfo() {
Douglas Gregor83fd0152010-03-30 17:32:08 +000087 llvm::PrintStatistics();
88}
Chris Lattnerc758fe62002-10-01 22:35:45 +000089
Douglas Gregor83fd0152010-03-30 17:32:08 +000090void llvm::EnableStatistics() {
91 Enabled.setValue(true);
92}
93
Daniel Dunbar06dfe8e2011-02-26 23:17:12 +000094bool llvm::AreStatisticsEnabled() {
95 return Enabled;
96}
97
Douglas Gregor83fd0152010-03-30 17:32:08 +000098void llvm::PrintStatistics(raw_ostream &OS) {
99 StatisticInfo &Stats = *StatInfo;
Chris Lattnerc758fe62002-10-01 22:35:45 +0000100
Chris Lattner8c9969a2006-12-08 20:00:42 +0000101 // Figure out how long the biggest Value and Name fields are.
102 unsigned MaxNameLen = 0, MaxValLen = 0;
Douglas Gregor83fd0152010-03-30 17:32:08 +0000103 for (size_t i = 0, e = Stats.Stats.size(); i != e; ++i) {
Chris Lattner8c9969a2006-12-08 20:00:42 +0000104 MaxValLen = std::max(MaxValLen,
Douglas Gregor83fd0152010-03-30 17:32:08 +0000105 (unsigned)utostr(Stats.Stats[i]->getValue()).size());
Chris Lattner8c9969a2006-12-08 20:00:42 +0000106 MaxNameLen = std::max(MaxNameLen,
Douglas Gregor83fd0152010-03-30 17:32:08 +0000107 (unsigned)std::strlen(Stats.Stats[i]->getName()));
Chris Lattnerc758fe62002-10-01 22:35:45 +0000108 }
Jim Grosbacha9277362010-08-17 17:37:22 +0000109
Chris Lattner8c9969a2006-12-08 20:00:42 +0000110 // Sort the fields by name.
Benjamin Kramer3a377bc2014-03-01 11:47:00 +0000111 std::stable_sort(Stats.Stats.begin(), Stats.Stats.end(),
112 [](const Statistic *LHS, const Statistic *RHS) {
113 if (int Cmp = std::strcmp(LHS->getName(), RHS->getName()))
114 return Cmp < 0;
115
116 // Secondary key is the description.
117 return std::strcmp(LHS->getDesc(), RHS->getDesc()) < 0;
118 });
Chris Lattnerc758fe62002-10-01 22:35:45 +0000119
Chris Lattner8c9969a2006-12-08 20:00:42 +0000120 // Print out the statistics header...
Douglas Gregor83fd0152010-03-30 17:32:08 +0000121 OS << "===" << std::string(73, '-') << "===\n"
122 << " ... Statistics Collected ...\n"
123 << "===" << std::string(73, '-') << "===\n\n";
Jim Grosbacha9277362010-08-17 17:37:22 +0000124
Chris Lattner8c9969a2006-12-08 20:00:42 +0000125 // Print all of the statistics.
Benjamin Kramercc863b22011-10-16 16:30:34 +0000126 for (size_t i = 0, e = Stats.Stats.size(); i != e; ++i)
127 OS << format("%*u %-*s - %s\n",
128 MaxValLen, Stats.Stats[i]->getValue(),
129 MaxNameLen, Stats.Stats[i]->getName(),
130 Stats.Stats[i]->getDesc());
Jim Grosbacha9277362010-08-17 17:37:22 +0000131
Douglas Gregor83fd0152010-03-30 17:32:08 +0000132 OS << '\n'; // Flush the output stream.
133 OS.flush();
134
135}
136
137void llvm::PrintStatistics() {
Jan Wen Voung7857a642013-03-08 22:56:31 +0000138#if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
Douglas Gregor83fd0152010-03-30 17:32:08 +0000139 StatisticInfo &Stats = *StatInfo;
140
141 // Statistics not enabled?
142 if (Stats.Stats.empty()) return;
143
144 // Get the stream to write to.
Rafael Espindolab94ab5f2015-12-16 22:28:34 +0000145 std::unique_ptr<raw_ostream> OutStream = CreateInfoOutputFile();
146 PrintStatistics(*OutStream);
147
Jan Wen Voung7857a642013-03-08 22:56:31 +0000148#else
149 // Check if the -stats option is set instead of checking
150 // !Stats.Stats.empty(). In release builds, Statistics operators
151 // do nothing, so stats are never Registered.
152 if (Enabled) {
153 // Get the stream to write to.
Rafael Espindolab94ab5f2015-12-16 22:28:34 +0000154 std::unique_ptr<raw_ostream> OutStream = CreateInfoOutputFile();
155 (*OutStream) << "Statistics are disabled. "
156 << "Build with asserts or with -DLLVM_ENABLE_STATS\n";
Jan Wen Voung7857a642013-03-08 22:56:31 +0000157 }
158#endif
Chris Lattner9eb00522002-05-10 15:36:46 +0000159}