src/sim/power/mathexpr_powermodel.hh

   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_MATHEXPR_POWERMODEL_PM_HH__
  41 #define __SIM_MATHEXPR_POWERMODEL_PM_HH__
  42
  43 #include <unordered_map>
  44
  45 #include "base/statistics.hh"
  46 #include "params/MathExprPowerModel.hh"
  47 #include "sim/mathexpr.hh"
  48 #include "sim/power/power_model.hh"
  49 #include "sim/sim_object.hh"
  50
  51 /**
  52  * A Equation power model. The power is represented as a combination
  53  * of some stats and automatic variables (like temperature).
  54  */
  55 class MathExprPowerModel : public PowerModelState
  56 {
  57   public:
  58
  59     typedef MathExprPowerModelParams Params;
  60     MathExprPowerModel(const Params *p);
  61
  62     /**
  63      * Get the dynamic power consumption.
  64      *
  65      * @return Power (Watts) consumed by this object (dynamic component)
  66      */
  67     double getDynamicPower() const {
  68         return dyn_expr.eval(
  69             std::bind(&MathExprPowerModel::getStatValue,
  70                 this, std::placeholders::_1)
  71         );
  72     }
  73
  74     /**
  75      * Get the static power consumption.
  76      *
  77      * @return Power (Watts) consumed by this object (static component)
  78      */
  79     double getStaticPower() const {
  80         return st_expr.eval(
  81             std::bind(&MathExprPowerModel::getStatValue,
  82                 this, std::placeholders::_1)
  83         );
  84     }
  85
  86     /**
  87      * Get the value for a variable (maps to a stat)
  88      *
  89      * @param name Name of the variable to retrieve the value from
  90      *
  91      * @return Power (Watts) consumed by this object (static component)
  92      */
  93     double getStatValue(const std::string & name) const;
  94
  95     void startup();
  96
  97     void regStats();
  98
  99   private:
 100
 101     // Math expressions for dynamic and static power
 102     MathExpr dyn_expr, st_expr;
 103
 104     // Basename of the object in the gem5 stats hierachy
 105     std::string basename;
 106
 107     // Map that contains relevant stats for this power model
 108     std::unordered_map<std::string, Stats::Info*> stats_map;
 109 };
 110
 111 #endif