group.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2019, 2020 Arm Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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 __BASE_STATS_GROUP_HH__
#define __BASE_STATS_GROUP_HH__
 
#include <map>
#include <string>
#include <vector>
 
#include "base/compiler.hh"
#include "base/stats/units.hh"
 
namespace gem5
{
 
#define ADD_STAT(n, ...) n(this, #n, __VA_ARGS__)
 
namespace statistics
{
 
class Info;
 
class Group
{
  public:
    Group() = delete;
    Group(const Group &) = delete;
    Group &operator=(const Group &) = delete; //end of api_stats
 
    Group(Group *parent, const char *name = nullptr);
 
    virtual ~Group();
 
    virtual void regStats();
 
    virtual void resetStats();
 
    virtual void preDumpStats();
 
    void addStat(statistics::Info *info);
 
    const std::map<std::string, Group *> &getStatGroups() const;
 
    const std::vector<Info *> &getStats() const;
 
    void addStatGroup(const char *name, Group *block);
 
    const Info * resolveStat(std::string name) const;
 
    void mergeStatGroup(Group *block);
 
  private:
    Group *mergedParent;
 
    std::map<std::string, Group *> statGroups;
    std::vector<Group *> mergedStatGroups;
    std::vector<Info *> stats;
};
 
} // namespace statistics
} // namespace gem5
 
#endif // __BASE_STATS_GROUP_HH__