power_model.hh revision 12546:8182d78bebcb 
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 * A PowerModel is a class containing a power model for a SimObject.
114 * The PM describes the power consumption for every power state.
115 */
116class PowerModel : public SimObject
117{
118  public:
119
120    typedef PowerModelParams Params;
121    PowerModel(const Params *p);
122
123    /**
124     * Get the dynamic power consumption.
125     *
126     * @return Power (Watts) consumed by this object (dynamic component)
127     */
128    double getDynamicPower() const;
129
130    /**
131     * Get the static power consumption.
132     *
133     * @return Power (Watts) consumed by this object (static component)
134     */
135    double getStaticPower() const;
136
137    void regStats() {
138        dynamicPower
139          .method(this, &PowerModel::getDynamicPower)
140          .name(params()->name + ".dynamic_power")
141          .desc("Dynamic power for this power state")
142        ;
143
144        staticPower
145          .method(this, &PowerModel::getStaticPower)
146          .name(params()->name + ".static_power")
147          .desc("Static power for this power state")
148        ;
149    }
150
151    void setClockedObject(ClockedObject *clkobj);
152
153    virtual void regProbePoints();
154
155    void thermalUpdateCallback(const double & temp);
156
157  protected:
158    /** Listener class to catch thermal events */
159    class ThermalProbeListener : public ProbeListenerArgBase<double>
160    {
161      public:
162        ThermalProbeListener(PowerModel &_pm, ProbeManager *pm,
163                      const std::string &name)
164            : ProbeListenerArgBase(pm, name), pm(_pm) {}
165
166        void notify(const double &temp)
167        {
168            pm.thermalUpdateCallback(temp);
169        }
170
171      protected:
172        PowerModel &pm;
173    };
174
175    Stats::Value dynamicPower, staticPower;
176
177    /** Actual power models (one per power state) */
178    std::vector<PowerModelState*> states_pm;
179
180    /** Listener to catch temperature changes in the SubSystem */
181    std::unique_ptr<ThermalProbeListener> thermalListener;
182
183    /** The subsystem this power model belongs to */
184    SubSystem * subsystem;
185
186    /** The clocked object we belong to */
187    ClockedObject * clocked_object;
188
189    /** The type of power model - collects all power, static or dynamic only */
190    Enums::PMType power_model_type;
191};
192
193#endif
194