stats.cc revision 14205:197360deaa20 
1/*
2 * Copyright (c) 2017, 2019 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2006 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Nathan Binkert
41 *          Andreas Sandberg
42 */
43
44#include "pybind11/pybind11.h"
45#include "pybind11/stl.h"
46
47#include "base/statistics.hh"
48#include "base/stats/text.hh"
49#include "sim/stat_control.hh"
50#include "sim/stat_register.hh"
51
52namespace py = pybind11;
53
54namespace Stats {
55
56void
57pythonDump()
58{
59    py::module m = py::module::import("m5.stats");
60    m.attr("dump")();
61}
62
63void
64pythonReset()
65{
66    py::module m = py::module::import("m5.stats");
67    m.attr("reset")();
68}
69
70}
71
72void
73pybind_init_stats(py::module &m_native)
74{
75    py::module m = m_native.def_submodule("stats");
76
77    m
78        .def("initSimStats", &Stats::initSimStats)
79        .def("initText", &Stats::initText, py::return_value_policy::reference)
80        .def("registerPythonStatsHandlers",
81             &Stats::registerPythonStatsHandlers)
82        .def("schedStatEvent", &Stats::schedStatEvent)
83        .def("periodicStatDump", &Stats::periodicStatDump)
84        .def("updateEvents", &Stats::updateEvents)
85        .def("processResetQueue", &Stats::processResetQueue)
86        .def("processDumpQueue", &Stats::processDumpQueue)
87        .def("enable", &Stats::enable)
88        .def("enabled", &Stats::enabled)
89        .def("statsList", &Stats::statsList)
90        ;
91
92    py::class_<Stats::Output>(m, "Output")
93        .def("begin", &Stats::Output::begin)
94        .def("end", &Stats::Output::end)
95        .def("valid", &Stats::Output::valid)
96        .def("beginGroup", &Stats::Output::beginGroup)
97        .def("endGroup", &Stats::Output::endGroup)
98        ;
99
100    py::class_<Stats::Info, std::unique_ptr<Stats::Info, py::nodelete>>(
101        m, "Info")
102        .def_readwrite("name", &Stats::Info::name)
103        .def_readonly("desc", &Stats::Info::desc)
104        .def_readonly("id", &Stats::Info::id)
105        .def_property_readonly("flags", [](const Stats::Info &info) {
106                return (Stats::FlagsType)info.flags;
107            })
108        .def("check", &Stats::Info::check)
109        .def("baseCheck", &Stats::Info::baseCheck)
110        .def("enable", &Stats::Info::enable)
111        .def("prepare", &Stats::Info::prepare)
112        .def("reset", &Stats::Info::reset)
113        .def("zero", &Stats::Info::zero)
114        .def("visit", &Stats::Info::visit)
115        ;
116
117    py::class_<Stats::Group, std::unique_ptr<Stats::Group, py::nodelete>>(
118        m, "Group")
119        .def("regStats", &Stats::Group::regStats)
120        .def("resetStats", &Stats::Group::resetStats)
121        .def("getStats", &Stats::Group::getStats)
122        .def("getStatGroups", &Stats::Group::getStatGroups)
123        .def("addStatGroup", &Stats::Group::addStatGroup)
124        ;
125}
126