Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics: Use a C++ syntax that I know :-3
[simgrid.git] / src / surf / plugins / energy.cpp
index 8719d9c..ca80808 100644 (file)
-/* Copyright (c) 2010, 2012-2013. The SimGrid Team.
+/* Copyright (c) 2010, 2012-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 * under the terms of the license (GNU LGPL) which comes with this package. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "energy.hpp"
 #include "../cpu_cas01.hpp"
 
 /** @addtogroup SURF_plugin_energy
- *    
- *  
- *  BlaBla energy
+
+
+This is the energy plugin, enabling to account not only for computation time,
+but also for the dissipated energy in the simulated platform.
+
+The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
+
+\verbatim
+<host id="HostA" power="100.0Mf" >
+    <prop id="watt_per_state" value="100.0:200.0" />
+    <prop id="watt_off" value="10" />
+</host>
+\endverbatim
+
+The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
+If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
+The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these values are arbitrary).
+
+If your CPU is using pstates, then you can provide one consumption interval per pstate.
+
+\verbatim
+<host id="HostB" power="100.0Mf,50.0Mf,20.0Mf" pstate="0" >
+    <prop id="watt_per_state" value="95.0:200.0, 93.0:170.0, 90.0:150.0" />
+    <prop id="watt_off" value="10" />
+</host>
+\endverbatim
+
+That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s.
+It starts at pstate 0 (ie, at 100 Mflop/s). In this case, you have to specify one interval per pstate in the watt_per_state property.
+In this example, the idle consumption is 95 Watts, 93 Watts and 90 Watts in each pstate while the CPU burn consumption are at 200 Watts,
+170 Watts and 150 Watts respectively.
+
+To change the pstate of a given CPU, use the following functions: #MSG_host_get_nb_pstates(), #MSG_host_set_pstate(), #MSG_host_get_power_peak_at().
+
+To simulate the energy-related elements, first call the #sg_energy_plugin_init() before your #MSG_init(),
+and then use the following function to retrieve the consumption of a given host: #MSG_host_get_consumed_energy().
  */
 
 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
                                 "Logging specific to the SURF energy plugin");
 
-std::map<CpuPtr, CpuEnergyPtr> *surf_energy=NULL;
+std::map<Cpu*, CpuEnergy*> *surf_energy=NULL;
 
-static void createCpuCallback(CpuPtr cpu){
+static void energyCpuCreatedCallback(Cpu *cpu){
   (*surf_energy)[cpu] = new CpuEnergy(cpu);
 }
 
-static void deleteCpuCallback(CpuPtr cpu){
-  std::map<CpuPtr, CpuEnergyPtr>::iterator cpuIt = surf_energy->find(cpu);
-  xbt_assert(cpuIt != surf_energy->end(), "The cpu is not in surf_energy.");
-  XBT_INFO("Total energy (Joules) of host %s: %f", cpu->getName(), cpuIt->second->getConsumedEnergy());
-  delete cpuIt->second;
-  surf_energy->erase(cpuIt);
+static void update_consumption_running(Cpu *cpu, CpuEnergy *cpu_energy) {
+       double cpu_load = lmm_constraint_get_usage(cpu->getConstraint()) / cpu->m_powerPeak;
+       double start_time = cpu_energy->last_updated;
+       double finish_time = surf_get_clock();
+
+       double previous_energy = cpu_energy->total_energy;
+       double energy_this_step = cpu_energy->getCurrentWattsValue(cpu_load)*(finish_time-start_time);
+
+       cpu_energy->total_energy = previous_energy + energy_this_step;
+       cpu_energy->last_updated = finish_time;
+
+       XBT_DEBUG("[cpu_update_energy] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
+                 start_time, finish_time, cpu->m_powerPeak, previous_energy, energy_this_step);
 }
+static void update_consumption_off(Cpu *cpu, CpuEnergy *cpu_energy) {
+       double start_time = cpu_energy->last_updated;
+       double finish_time = surf_get_clock();
 
-static void updateActionEnergyCallback(CpuActionPtr action){
-  CpuPtr cpu  = getActionCpu(action);
-  CpuEnergyPtr cpu_energy = (*surf_energy)[cpu];
+       double previous_energy = cpu_energy->total_energy;
+       double energy_this_step = cpu_energy->watts_off*(finish_time-start_time);
 
-  if(cpu_energy->last_updated < surf_get_clock()) {
-       double cpu_load = lmm_constraint_get_usage(cpu->getConstraint()) / cpu->m_powerPeak;
-    double start_time = cpu_energy->last_updated;
-    double finish_time = surf_get_clock();
+       cpu_energy->total_energy = previous_energy + energy_this_step;
+       cpu_energy->last_updated = finish_time;
+
+       XBT_DEBUG("[cpu_update_energy] off period=[%.2f-%.2f]; consumption change: %.2f J -> %.2f J",
+                 start_time, finish_time, previous_energy, energy_this_step);
+}
+
+static void energyCpuDestructedCallback(Cpu *cpu){
+  std::map<Cpu*, CpuEnergy*>::iterator cpu_energy_it = surf_energy->find(cpu);
+  xbt_assert(cpu_energy_it != surf_energy->end(), "The cpu is not in surf_energy.");
+
+  CpuEnergy *cpu_energy = cpu_energy_it->second;
+  if (cpu->getState() == SURF_RESOURCE_OFF)
+         update_consumption_off(cpu, cpu_energy);
+  else
+         update_consumption_running(cpu, cpu_energy);
+
+  XBT_INFO("Total energy of host %s: %f Joules", cpu->getName(), cpu_energy->getConsumedEnergy());
+  delete cpu_energy_it->second;
+  surf_energy->erase(cpu_energy_it);
+}
+
+static void energyCpuActionStateChangedCallback(CpuAction *action, e_surf_action_state_t old, e_surf_action_state_t cur){
+  Cpu *cpu  = getActionCpu(action);
+  CpuEnergy *cpu_energy = (*surf_energy)[cpu];
 
-    /*XBT_DEBUG("[cpu_update_energy] action time interval=(%f-%f), current power peak=%f, current pstate=%d",
-                 start_time, finish_time, cpu->m_powerPeak, cpu->m_pstate);*/
-    XBT_DEBUG("[cpu_update_energy] action time interval=(%f-%f), current power peak=%f",
-                 start_time, finish_time, cpu->m_powerPeak);
-    double current_energy = cpu_energy->total_energy;
-    double action_energy = cpu_energy->getCurrentWattsValue(cpu_load)*(finish_time-start_time);
+  if(cpu_energy->last_updated < surf_get_clock()) {
+         update_consumption_running(cpu, cpu_energy);
+  }
+}
 
-    cpu_energy->total_energy = current_energy + action_energy;
-    cpu_energy->last_updated = finish_time;
+static void energyStateChangedCallback(Cpu *cpu, e_surf_resource_state_t oldState, e_surf_resource_state_t newState){
+  CpuEnergy *cpu_energy = (*surf_energy)[cpu];
 
-    XBT_DEBUG("[cpu_update_energy] old_energy_value=%f, action_energy_value=%f", current_energy, action_energy);
+  if(cpu_energy->last_updated < surf_get_clock()) {
+         if (oldState == SURF_RESOURCE_OFF)
+                 update_consumption_off(cpu, cpu_energy);
+         else
+                 update_consumption_running(cpu, cpu_energy);
   }
 }
 
+static void sg_energy_plugin_exit()
+{
+  delete surf_energy;
+  surf_energy = NULL;
+}
+
 /** \ingroup SURF_plugin_energy
  * \brief Enable energy plugin
- * \details Enable energy plugin to get joules consumption of each cpu.
+ * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
  */
 void sg_energy_plugin_init() {
   if (surf_energy == NULL) {
-    surf_energy = new std::map<CpuPtr, CpuEnergyPtr>();
-    surf_callback_connect(createCpuCallbacks, createCpuCallback);
-    surf_callback_connect(deleteCpuCallbacks, deleteCpuCallback);
-    surf_callback_connect(updateCpuActionCallbacks, updateActionEnergyCallback);
+    surf_energy = new std::map<Cpu*, CpuEnergy*>();
+    surf_callback_connect(cpuCreatedCallbacks, energyCpuCreatedCallback);
+    surf_callback_connect(cpuDestructedCallbacks, energyCpuDestructedCallback);
+    surf_callback_connect(cpuActionStateChangedCallbacks, energyCpuActionStateChangedCallback);
+    surf_callback_connect(surfExitCallbacks, sg_energy_plugin_exit);
+    surf_callback_connect(cpuStateChangedCallbacks, energyStateChangedCallback);
   }
 }
 
 /**
  *
  */
-CpuEnergy::CpuEnergy(CpuPtr ptr)
- : cpu(ptr)
+CpuEnergy::CpuEnergy(Cpu *ptr)
 {
+  cpu = ptr;
   total_energy = 0;
   power_range_watts_list = getWattsRangeList();
   last_updated = surf_get_clock();
+
+  if (cpu->getProperties() != NULL) {
+       char* off_power_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "watt_off");
+       if (off_power_str != NULL)
+               watts_off = atof(off_power_str);
+       else
+               watts_off = 0;
+  }
+
 }
 
 CpuEnergy::~CpuEnergy(){
@@ -87,6 +169,21 @@ CpuEnergy::~CpuEnergy(){
 }
 
 
+double CpuEnergy::getWattMinAt(int pstate) {
+  xbt_dynar_t power_range_list = power_range_watts_list;
+  xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
+  xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
+  double min_power = xbt_dynar_get_as(current_power_values, 0, double);
+  return min_power;
+}
+double CpuEnergy::getWattMaxAt(int pstate) {
+  xbt_dynar_t power_range_list = power_range_watts_list;
+  xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
+  xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
+  double max_power = xbt_dynar_get_as(current_power_values, 1, double);
+  return max_power;
+}
+
 /**
  * Computes the power consumed by the host according to the current pstate and processor load
  *
@@ -94,18 +191,10 @@ CpuEnergy::~CpuEnergy(){
 double CpuEnergy::getCurrentWattsValue(double cpu_load)
 {
        xbt_dynar_t power_range_list = power_range_watts_list;
-
-       if (power_range_list == NULL)
-       {
-               XBT_DEBUG("No power range properties specified for host %s", cpu->getName());
-               return 0;
-       }
-       /*xbt_assert(xbt_dynar_length(power_range_list) == xbt_dynar_length(cpu->p_powerPeakList),
-                                               "The number of power ranges in the properties does not match the number of pstates for host %s",
-                                               cpu->getName());*/
+       xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
 
     /* retrieve the power values associated with the current pstate */
-    xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01Ptr>(cpu)->m_pstate, xbt_dynar_t);
+    xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
 
     /* min_power corresponds to the idle power (cpu load = 0) */
     /* max_power is the power consumed at 100% cpu load       */
@@ -123,6 +212,12 @@ double CpuEnergy::getCurrentWattsValue(double cpu_load)
 
 double CpuEnergy::getConsumedEnergy()
 {
+       if(last_updated < surf_get_clock()) {
+               if (cpu->getState() == SURF_RESOURCE_OFF)
+                       update_consumption_off(cpu, this);
+               else
+                       update_consumption_running(cpu, this);
+       }
   return total_energy;
 }
 
@@ -137,7 +232,7 @@ xbt_dynar_t CpuEnergy::getWattsRangeList()
        if (cpu->getProperties() == NULL)
                return NULL;
 
-       char* all_power_values_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "power_per_state");
+       char* all_power_values_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "watt_per_state");
 
        if (all_power_values_str == NULL)
                return NULL;