power_model.hh revision 11800:54436a1784dc 
1/*
2 * Copyright (c) 2016 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 "params/PowerModel.hh"
45#include "params/PowerModelState.hh"
46#include "sim/probe/probe.hh"
47
48class SimObject;
49class ClockedObject;
50
51/**
52 * A PowerModelState is an abstract class used as interface to get power
53 * figures out of SimObjects
54 */
55class PowerModelState : public SimObject
56{
57  public:
58
59    typedef PowerModelStateParams Params;
60    PowerModelState(const Params *p);
61
62    /**
63     * Get the dynamic power consumption.
64     *
65     * @return Power (Watts) consumed by this object (dynamic component)
66     */
67    virtual double getDynamicPower() const = 0;
68
69    /**
70     * Get the static power consumption.
71     *
72     * @return Power (Watts) consumed by this object (static component)
73     */
74    virtual double getStaticPower() const = 0;
75
76    /**
77     * Temperature update.
78     *
79     * @param temp Current temperature of the HW part (Celsius)
80     */
81    virtual void setTemperature(double temp) { _temp = temp; }
82
83    void setClockedObject(ClockedObject * clkobj) {
84        clocked_object = clkobj;
85    }
86
87    void regStats() {
88        dynamicPower
89          .method(this, &PowerModelState::getDynamicPower)
90          .name(params()->name + ".dynamic_power")
91          .desc("Dynamic power for this object (Watts)")
92        ;
93
94        staticPower
95          .method(this, &PowerModelState::getStaticPower)
96          .name(params()->name + ".static_power")
97          .desc("Static power for this object (Watts)")
98        ;
99    }
100
101  protected:
102    Stats::Value dynamicPower, staticPower;
103
104    /** Current temperature */
105    double _temp;
106
107    /** The clocked object we belong to */
108    ClockedObject * clocked_object;
109};
110
111/**
112 * A PowerModel is a class containing a power model for a SimObject.
113 * The PM describes the power consumption for every power state.
114 */
115class PowerModel : public SimObject
116{
117  public:
118
119    typedef PowerModelParams Params;
120    PowerModel(const Params *p);
121
122    /**
123     * Get the dynamic power consumption.
124     *
125     * @return Power (Watts) consumed by this object (dynamic component)
126     */
127    double getDynamicPower() const;
128
129    /**
130     * Get the static power consumption.
131     *
132     * @return Power (Watts) consumed by this object (static component)
133     */
134    double getStaticPower() const;
135
136    void regStats() {
137        dynamicPower
138          .method(this, &PowerModel::getDynamicPower)
139          .name(params()->name + ".dynamic_power")
140          .desc("Dynamic power for this power state")
141        ;
142
143        staticPower
144          .method(this, &PowerModel::getStaticPower)
145          .name(params()->name + ".static_power")
146          .desc("Static power for this power state")
147        ;
148    }
149
150    void setClockedObject(ClockedObject *clkobj);
151
152    virtual void regProbePoints();
153
154    void thermalUpdateCallback(const double & temp);
155
156  protected:
157    /** Listener class to catch thermal events */
158    class ThermalProbeListener : public ProbeListenerArgBase<double>
159    {
160      public:
161        ThermalProbeListener(PowerModel &_pm, ProbeManager *pm,
162                      const std::string &name)
163            : ProbeListenerArgBase(pm, name), pm(_pm) {}
164
165        void notify(const double &temp)
166        {
167            pm.thermalUpdateCallback(temp);
168        }
169
170      protected:
171        PowerModel &pm;
172    };
173
174    Stats::Value dynamicPower, staticPower;
175
176    /** Actual power models (one per power state) */
177    std::vector<PowerModelState*> states_pm;
178
179    /** Listener to catch temperature changes in the SubSystem */
180    std::unique_ptr<ThermalProbeListener> thermalListener;
181
182    /** The subsystem this power model belongs to */
183    SubSystem * subsystem;
184
185    /** The clocked object we belong to */
186    ClockedObject * clocked_object;
187};
188
189#endif
190