1/*
2 * Copyright (c) 2016, 2018 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 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: David Guillen Fandos
38 */
39
40#ifndef __SIM_POWER_POWER_MODEL_HH__
41#define __SIM_POWER_POWER_MODEL_HH__
42
43#include "base/statistics.hh"
44#include "enums/PMType.hh"
45#include "params/PowerModel.hh"
46#include "params/PowerModelState.hh"
47#include "sim/probe/probe.hh"
48
49class SimObject;
50class ClockedObject;
51
52/**
53 * A PowerModelState is an abstract class used as interface to get power
54 * figures out of SimObjects
55 */
56class PowerModelState : public SimObject
57{
58  public:
59
60    typedef PowerModelStateParams Params;
61    PowerModelState(const Params *p);
62
63    /**
64     * Get the dynamic power consumption.
65     *
66     * @return Power (Watts) consumed by this object (dynamic component)
67     */
68    virtual double getDynamicPower() const = 0;
69
70    /**
71     * Get the static power consumption.
72     *
73     * @return Power (Watts) consumed by this object (static component)
74     */
75    virtual double getStaticPower() const = 0;
76
77    /**
78     * Temperature update.
79     *
80     * @param temp Current temperature of the HW part (Celsius)
81     */
82    virtual void setTemperature(double temp) { _temp = temp; }
83
84    void setClockedObject(ClockedObject * clkobj) {
85        clocked_object = clkobj;
86    }
87
88    void regStats() {
89        dynamicPower
90          .method(this, &PowerModelState::getDynamicPower)
91          .name(params()->name + ".dynamic_power")
92          .desc("Dynamic power for this object (Watts)")
93        ;
94
95        staticPower
96          .method(this, &PowerModelState::getStaticPower)
97          .name(params()->name + ".static_power")
98          .desc("Static power for this object (Watts)")
99        ;
100    }
101
102  protected:
103    Stats::Value dynamicPower, staticPower;
104
105    /** Current temperature */
106    double _temp;
107
108    /** The clocked object we belong to */
109    ClockedObject * clocked_object;
110};
111
112/**
113 * @sa \ref gem5PowerModel "gem5 Power Model"
114 *
115 * A PowerModel is a class containing a power model for a SimObject.
116 * The PM describes the power consumption for every power state.
117 */
118class PowerModel : public SimObject
119{
120  public:
121
122    typedef PowerModelParams Params;
123    PowerModel(const Params *p);
124
125    /**
126     * Get the dynamic power consumption.
127     *
128     * @return Power (Watts) consumed by this object (dynamic component)
129     */
130    double getDynamicPower() const;
131
132    /**
133     * Get the static power consumption.
134     *
135     * @return Power (Watts) consumed by this object (static component)
136     */
137    double getStaticPower() const;
138
139    void regStats() {
140        dynamicPower
141          .method(this, &PowerModel::getDynamicPower)
142          .name(params()->name + ".dynamic_power")
143          .desc("Dynamic power for this power state")
144        ;
145
146        staticPower
147          .method(this, &PowerModel::getStaticPower)
148          .name(params()->name + ".static_power")
149          .desc("Static power for this power state")
150        ;
151    }
152
153    void setClockedObject(ClockedObject *clkobj);
154
155    virtual void regProbePoints();
156
157    void thermalUpdateCallback(const double & temp);
158
159  protected:
160    /** Listener class to catch thermal events */
161    class ThermalProbeListener : public ProbeListenerArgBase<double>
162    {
163      public:
164        ThermalProbeListener(PowerModel &_pm, ProbeManager *pm,
165                      const std::string &name)
166            : ProbeListenerArgBase(pm, name), pm(_pm) {}
167
168        void notify(const double &temp)
169        {
170            pm.thermalUpdateCallback(temp);
171        }
172
173      protected:
174        PowerModel &pm;
175    };
176
177    Stats::Value dynamicPower, staticPower;
178
179    /** Actual power models (one per power state) */
180    std::vector<PowerModelState*> states_pm;
181
182    /** Listener to catch temperature changes in the SubSystem */
183    std::unique_ptr<ThermalProbeListener> thermalListener;
184
185    /** The subsystem this power model belongs to */
186    SubSystem * subsystem;
187
188    /** The clocked object we belong to */
189    ClockedObject * clocked_object;
190
191    /** The type of power model - collects all power, static or dynamic only */
192    Enums::PMType power_model_type;
193};
194
195#endif
196