mathexpr_powermodel.hh revision 11967:e963e6ce139b 
1/*
2 * Copyright (c) 2016-2017 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_MATHEXPR_POWERMODEL_PM_HH__
41#define __SIM_MATHEXPR_POWERMODEL_PM_HH__
42
43#include <unordered_map>
44
45#include "params/MathExprPowerModel.hh"
46#include "sim/mathexpr.hh"
47#include "sim/power/power_model.hh"
48
49namespace Stats {
50    class Info;
51}
52
53/**
54 * A Equation power model. The power is represented as a combination
55 * of some stats and automatic variables (like temperature).
56 */
57class MathExprPowerModel : public PowerModelState
58{
59  public:
60
61    typedef MathExprPowerModelParams Params;
62    MathExprPowerModel(const Params *p);
63
64    /**
65     * Get the dynamic power consumption.
66     *
67     * @return Power (Watts) consumed by this object (dynamic component)
68     */
69    double getDynamicPower() const { return eval(dyn_expr); }
70
71    /**
72     * Get the static power consumption.
73     *
74     * @return Power (Watts) consumed by this object (static component)
75     */
76    double getStaticPower() const { return eval(st_expr); }
77
78    /**
79     * Get the value for a variable (maps to a stat)
80     *
81     * @param name Name of the variable to retrieve the value from
82     *
83     * @return Power (Watts) consumed by this object (static component)
84     */
85    double getStatValue(const std::string & name) const;
86
87    void startup();
88
89    void regStats();
90
91  private:
92    /**
93     * Evaluate an expression in the context of this object, fatal if
94     * evaluation fails.
95     *
96     * @param expr Expression to evaluate
97     * @return Value of expression.
98     */
99    double eval(const MathExpr &expr) const;
100
101    /**
102     * Evaluate an expression in the context of this object, set
103     * failed if evaluation failed.
104     *
105     * @param expr Expression to evaluate
106     * @return Value of expression.
107     */
108    double tryEval(const MathExpr &expr) const;
109
110    // Math expressions for dynamic and static power
111    MathExpr dyn_expr, st_expr;
112
113    // Basename of the object in the gem5 stats hierachy
114    std::string basename;
115
116    // Map that contains relevant stats for this power model
117    std::unordered_map<std::string, Stats::Info*> stats_map;
118
119    // Did the expression fail to evaluate (e.g., because a stat value
120    // can't be resolved)
121    mutable bool failed;
122};
123
124#endif
125