verilator/src/V3Stats.h
2022-01-01 08:26:40 -05:00

127 lines
4.0 KiB
C++

// -*- mode: C++; c-file-style: "cc-mode" -*-
//*************************************************************************
// DESCRIPTION: Verilator: Collect and print statistics
//
// Code available from: https://verilator.org
//
//*************************************************************************
//
// Copyright 2005-2022 by Wilson Snyder. This program is free software; you
// can redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0.
// SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
//
//*************************************************************************
#ifndef VERILATOR_V3STATS_H_
#define VERILATOR_V3STATS_H_
#include "config_build.h"
#include "verilatedos.h"
#include "V3Error.h"
class AstNetlist;
//============================================================================
class VDouble0 final {
// Double counter, initializes to zero for easy use
double m_d = 0.0; ///< Count of occurrences/ value
public:
// METHODS
VDouble0() = default;
~VDouble0() = default;
// Implicit conversion operators:
explicit VDouble0(const vluint64_t v)
: m_d{static_cast<double>(v)} {}
operator double() const { return m_d; }
// Explicit operators:
VDouble0& operator++() { // prefix
++m_d;
return *this;
}
VDouble0 operator++(int) { // postfix
VDouble0 old = *this;
m_d++;
return old;
}
VDouble0& operator=(const double v) {
m_d = v;
return *this;
}
VDouble0& operator+=(const double v) {
m_d += v;
return *this;
}
VDouble0& operator-=(const double v) {
m_d -= v;
return *this;
}
};
//============================================================================
class V3Statistic final {
// A statistical entry we want published into the database
const string m_name; ///< Name of this statistic
double m_count; ///< Count of occurrences/ value
const string m_stage; ///< Runtime stage
const bool m_sumit; ///< Do summation of similar stats
const bool m_perf; ///< Performance section
bool m_printit = true; ///< Print the results
public:
// METHODS
string stage() const { return m_stage; }
string name() const { return m_name; }
double count() const { return m_count; }
bool sumit() const { return m_sumit; }
bool perf() const { return m_perf; }
bool printit() const { return m_printit; }
virtual void dump(std::ofstream& os) const;
void combineWith(V3Statistic* otherp) {
m_count += otherp->count();
otherp->m_printit = false;
}
// CONSTRUCTORS
V3Statistic(const string& stage, const string& name, double count, bool sumit = false,
bool perf = false)
: m_name{name}
, m_count{count}
, m_stage{stage}
, m_sumit{sumit}
, m_perf{perf} {}
virtual ~V3Statistic() = default;
};
//============================================================================
class V3Stats final {
public:
static void addStat(const V3Statistic&);
static void addStat(const string& stage, const string& name, double count) {
addStat(V3Statistic(stage, name, count));
}
static void addStat(const string& name, double count) {
addStat(V3Statistic("*", name, count));
}
static void addStatSum(const string& name, double count) {
addStat(V3Statistic("*", name, count, true));
}
static void addStatPerf(const string& name, double count) {
addStat(V3Statistic("*", name, count, true, true));
}
/// Called each stage
static void statsStage(const string& name);
/// Called by the top level to collect statistics
static void statsStageAll(AstNetlist* nodep, const string& stage, bool fast = false);
static void statsFinalAll(AstNetlist* nodep);
/// Called by the top level to dump the statistics
static void statsReport();
};
#endif // Guard