X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=lib%2FSupport%2FStatistic.cpp;h=d8a6ad35ba9cae8805ab9c9f3c1cef2ace2d1ba6;hb=e853d2e2508e21b5c3156c7d8b6e6902a7d2604a;hp=ae9f57f80ed365fb58270bf9f6b333abab772275;hpb=a4ca41eca75c71230c37bf052b920717876388d9;p=oota-llvm.git diff --git a/lib/Support/Statistic.cpp b/lib/Support/Statistic.cpp index ae9f57f80ed..d8a6ad35ba9 100644 --- a/lib/Support/Statistic.cpp +++ b/lib/Support/Statistic.cpp @@ -1,5 +1,12 @@ //===-- Statistic.cpp - Easy way to expose stats information --------------===// // +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// // This file implements the 'Statistic' class, which is designed to be an easy // way to expose various success metrics from passes. These statistics are // printed at the end of a run, when the -stats command line option is enabled @@ -8,92 +15,140 @@ // This is useful for reporting information like the number of instructions // simplified, optimized or removed by various transformations, like this: // -// static Statistic<> NumInstEliminated("GCSE - Number of instructions killed"); +// static Statistic NumInstEliminated("GCSE", "Number of instructions killed"); // // Later, in the code: ++NumInstEliminated; // //===----------------------------------------------------------------------===// -#include "Support/Statistic.h" -#include "Support/CommandLine.h" -#include -#include +#include "llvm/ADT/Statistic.h" +#include "llvm/Support/CommandLine.h" +#include "llvm/Support/Debug.h" +#include "llvm/Support/Format.h" +#include "llvm/Support/ManagedStatic.h" +#include "llvm/Support/raw_ostream.h" +#include "llvm/Support/Mutex.h" +#include "llvm/ADT/StringExtras.h" #include +#include +using namespace llvm; -// GetLibSupportInfoOutputFile - Return a file stream to print our output on... -std::ostream *GetLibSupportInfoOutputFile(); +// CreateInfoOutputFile - Return a file stream to print our output on. +namespace llvm { extern raw_ostream *CreateInfoOutputFile(); } -unsigned StatisticBase::NumStats = 0; - -// -stats - Command line option to cause transformations to emit stats about -// what they did. -// +/// -stats - Command line option to cause transformations to emit stats about +/// what they did. +/// static cl::opt Enabled("stats", cl::desc("Enable statistics output from program")); -struct StatRecord { - std::string Value; - const char *Name, *Desc; - StatRecord(const std::string V, const char *N, const char *D) - : Value(V), Name(N), Desc(D) {} +namespace { +/// StatisticInfo - This class is used in a ManagedStatic so that it is created +/// on demand (when the first statistic is bumped) and destroyed only when +/// llvm_shutdown is called. We print statistics from the destructor. +class StatisticInfo { + std::vector Stats; + friend void llvm::PrintStatistics(); + friend void llvm::PrintStatistics(raw_ostream &OS); +public: + ~StatisticInfo(); - bool operator<(const StatRecord &SR) const { - return std::strcmp(Name, SR.Name) < 0; + void addStatistic(const Statistic *S) { + Stats.push_back(S); } +}; +} - void print(unsigned ValFieldSize, unsigned NameFieldSize, - std::ostream &OS) { - OS << std::string(ValFieldSize-Value.length(), ' ') - << Value << " " << Name - << std::string(NameFieldSize-std::strlen(Name), ' ') - << " - " << Desc << "\n"; +static ManagedStatic StatInfo; +static ManagedStatic > StatLock; + +/// RegisterStatistic - The first time a statistic is bumped, this method is +/// called. +void Statistic::RegisterStatistic() { + // If stats are enabled, inform StatInfo that this statistic should be + // printed. + sys::SmartScopedLock Writer(*StatLock); + if (!Initialized) { + if (Enabled) + StatInfo->addStatistic(this); + + TsanHappensBefore(this); + sys::MemoryFence(); + // Remember we have been registered. + TsanIgnoreWritesBegin(); + Initialized = true; + TsanIgnoreWritesEnd(); } -}; +} -static std::vector *AccumStats = 0; +namespace { -// Print information when destroyed, iff command line option is specified -void StatisticBase::destroy() const { - if (Enabled && hasSomeData()) { - if (AccumStats == 0) - AccumStats = new std::vector(); +struct NameCompare { + bool operator()(const Statistic *LHS, const Statistic *RHS) const { + int Cmp = std::strcmp(LHS->getName(), RHS->getName()); + if (Cmp != 0) return Cmp < 0; - std::ostringstream Out; - printValue(Out); - AccumStats->push_back(StatRecord(Out.str(), Name, Desc)); + // Secondary key is the description. + return std::strcmp(LHS->getDesc(), RHS->getDesc()) < 0; } +}; + +} + +// Print information when destroyed, iff command line option is specified. +StatisticInfo::~StatisticInfo() { + llvm::PrintStatistics(); +} - if (--NumStats == 0 && AccumStats) { - std::ostream *OutStream = GetLibSupportInfoOutputFile(); - - // Figure out how long the biggest Value and Name fields are... - unsigned MaxNameLen = 0, MaxValLen = 0; - for (unsigned i = 0, e = AccumStats->size(); i != e; ++i) { - MaxValLen = std::max(MaxValLen, - (unsigned)(*AccumStats)[i].Value.length()); - MaxNameLen = std::max(MaxNameLen, - (unsigned)std::strlen((*AccumStats)[i].Name)); - } - - // Sort the fields... - std::stable_sort(AccumStats->begin(), AccumStats->end()); - - // Print out the statistics header... - *OutStream << "===" << std::string(73, '-') << "===\n" - << " ... Statistics Collected ...\n" - << "===" << std::string(73, '-') << "===\n\n"; - - // Print all of the statistics accumulated... - for (unsigned i = 0, e = AccumStats->size(); i != e; ++i) - (*AccumStats)[i].print(MaxValLen, MaxNameLen, *OutStream); - - *OutStream << std::endl; // Flush the output stream... - - // Free all accumulated statistics... - delete AccumStats; - AccumStats = 0; - if (OutStream != &std::cerr && OutStream != &std::cout) - delete OutStream; // Close the file... +void llvm::EnableStatistics() { + Enabled.setValue(true); +} + +bool llvm::AreStatisticsEnabled() { + return Enabled; +} + +void llvm::PrintStatistics(raw_ostream &OS) { + StatisticInfo &Stats = *StatInfo; + + // Figure out how long the biggest Value and Name fields are. + unsigned MaxNameLen = 0, MaxValLen = 0; + for (size_t i = 0, e = Stats.Stats.size(); i != e; ++i) { + MaxValLen = std::max(MaxValLen, + (unsigned)utostr(Stats.Stats[i]->getValue()).size()); + MaxNameLen = std::max(MaxNameLen, + (unsigned)std::strlen(Stats.Stats[i]->getName())); } + + // Sort the fields by name. + std::stable_sort(Stats.Stats.begin(), Stats.Stats.end(), NameCompare()); + + // Print out the statistics header... + OS << "===" << std::string(73, '-') << "===\n" + << " ... Statistics Collected ...\n" + << "===" << std::string(73, '-') << "===\n\n"; + + // Print all of the statistics. + for (size_t i = 0, e = Stats.Stats.size(); i != e; ++i) + OS << format("%*u %-*s - %s\n", + MaxValLen, Stats.Stats[i]->getValue(), + MaxNameLen, Stats.Stats[i]->getName(), + Stats.Stats[i]->getDesc()); + + OS << '\n'; // Flush the output stream. + OS.flush(); + +} + +void llvm::PrintStatistics() { + StatisticInfo &Stats = *StatInfo; + + // Statistics not enabled? + if (Stats.Stats.empty()) return; + + // Get the stream to write to. + raw_ostream &OutStream = *CreateInfoOutputFile(); + PrintStatistics(OutStream); + delete &OutStream; // Close the file. }