stat_tester.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2024 The Regents of the University of California
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __STAT_TESTER_HH__
#define __STAT_TESTER_HH__
 
#include "base/statistics.hh"
#include "params/ScalarStatTester.hh"
#include "params/SparseHistStatTester.hh"
#include "params/StatTester.hh"
#include "params/Vector2dStatTester.hh"
#include "params/VectorStatTester.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{

class StatTester : public SimObject
{
  private:
    EventFunctionWrapper event;
 
  public:
    StatTester(const StatTesterParams &p) :
        SimObject(p),
        event([this]{ setStats(); }, name() + ".event")
    {}
    void startup() override { schedule(event, curTick()); }
 
  protected:
    virtual void setStats(){}
};
 
class ScalarStatTester : public StatTester
{
 
  private:
    ScalarStatTesterParams params;
 
  public:
    ScalarStatTester(const ScalarStatTesterParams &p) :
        StatTester(p), params(p), stats(this, p) {}
 
  protected:
    void setStats() override;
    struct ScalarStatTesterStats : public statistics::Group
    {
        ScalarStatTesterStats(
            statistics::Group *parent,
            const ScalarStatTesterParams &params
        );
        statistics::Scalar scalar;
    } stats;
};
 
class VectorStatTester : public StatTester
{
    private:
        VectorStatTesterParams params;
 
    public:
        VectorStatTester(const VectorStatTesterParams &p) :
            StatTester(p), params(p), stats(this, p) {}
 
    protected:
        void setStats() override;
        struct VectorStatTesterStats : public statistics::Group
        {
            VectorStatTesterStats(
                statistics::Group *parent,
                const VectorStatTesterParams &params
            );
            statistics::Vector vector;
        } stats;
};
 
class Vector2dStatTester : public StatTester
{
    private:
        Vector2dStatTesterParams params;
 
    public:
        Vector2dStatTester(const Vector2dStatTesterParams &p) :
            StatTester(p), params(p), stats(this, p) {}
 
    protected:
        void setStats() override;
        struct Vector2dStatTesterStats : public statistics::Group
        {
            Vector2dStatTesterStats(
                statistics::Group *parent,
                const Vector2dStatTesterParams &params
            );
            statistics::Vector2d vector2d;
        } stats;
};
 
class SparseHistStatTester : public StatTester
{
    private:
        SparseHistStatTesterParams params;
 
    public:
        SparseHistStatTester(const SparseHistStatTesterParams &p) :
            StatTester(p), params(p), stats(this, p) {}
 
    protected:
        void setStats() override;
        struct SparseHistStatTesterStats : public statistics::Group
        {
            SparseHistStatTesterStats(
                statistics::Group *parent,
                const SparseHistStatTesterParams &params
            );
            statistics::SparseHistogram sparse_histogram;
        } stats;
};
 
 
} // namespace gem5
 
#endif // __STAT_TESTER_HH__