mathexpr_powermodel.cc revision 11968:f5da4fc4a6ff 
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#include "sim/power/mathexpr_powermodel.hh"
41
42#include "base/statistics.hh"
43#include "params/MathExprPowerModel.hh"
44#include "sim/mathexpr.hh"
45#include "sim/power/thermal_model.hh"
46#include "sim/sim_object.hh"
47
48MathExprPowerModel::MathExprPowerModel(const Params *p)
49    : PowerModelState(p), dyn_expr(p->dyn), st_expr(p->st), failed(false)
50{
51    // Calculate the name of the object we belong to
52    std::vector<std::string> path;
53    tokenize(path, name(), '.', true);
54    // It's something like xyz.power_model.pm2
55    assert(path.size() > 2);
56    for (unsigned i = 0; i < path.size() - 2; i++)
57        basename += path[i] + ".";
58}
59
60void
61MathExprPowerModel::startup()
62{
63    // Create a map with stats and pointers for quick access
64    // Has to be done here, since we need access to the statsList
65    for (auto & i: Stats::statsList())
66        if (i->name.find(basename) == 0)
67            stats_map[i->name.substr(basename.size())] = i;
68
69    tryEval(st_expr);
70    const bool st_failed = failed;
71
72    tryEval(dyn_expr);
73    const bool dyn_failed = failed;
74
75    if (st_failed || dyn_failed) {
76        const auto *p = dynamic_cast<const Params *>(params());
77        assert(p);
78
79        fatal("Failed to evaluate power expressions:\n%s%s%s\n",
80              st_failed ? p->st : "",
81              st_failed && dyn_failed ? "\n" : "",
82              dyn_failed ? p->dyn : "");
83    }
84}
85
86double
87MathExprPowerModel::eval(const MathExpr &expr) const
88{
89    const double value = tryEval(expr);
90
91    // This shouldn't happen unless something went wrong the equations
92    // were verified in startup().
93    panic_if(failed, "Failed to evaluate power expression '%s'\n",
94             expr.toStr());
95
96    return value;
97}
98
99double
100MathExprPowerModel::tryEval(const MathExpr &expr) const
101{
102    failed = false;
103    const double value = expr.eval(
104        std::bind(&MathExprPowerModel::getStatValue,
105                  this, std::placeholders::_1)
106        );
107
108    return value;
109}
110
111
112double
113MathExprPowerModel::getStatValue(const std::string &name) const
114{
115    using namespace Stats;
116
117    // Automatic variables:
118    if (name == "temp") {
119        return _temp;
120    } else if (name == "voltage") {
121        return clocked_object->voltage();
122    }
123
124    // Try to cast the stat, only these are supported right now
125    const auto it = stats_map.find(name);
126    if (it == stats_map.cend()) {
127        warn("Failed to find stat '%s'\n", name);
128        failed = true;
129        return 0;
130    }
131
132    const Info *info = it->second;
133
134    auto si = dynamic_cast<const ScalarInfo *>(info);
135    if (si)
136        return si->value();
137    auto fi = dynamic_cast<const FormulaInfo *>(info);
138    if (fi)
139        return fi->total();
140
141    panic("Unknown stat type!\n");
142}
143
144void
145MathExprPowerModel::regStats()
146{
147    PowerModelState::regStats();
148}
149
150MathExprPowerModel*
151MathExprPowerModelParams::create()
152{
153    return new MathExprPowerModel(this);
154}
155