Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
forgot that reference to a renamed function
[simgrid.git] / src / surf / plugins / energy.cpp
index 1ade83f..7023723 100644 (file)
@@ -8,9 +8,42 @@
 #include "../cpu_cas01.hpp"
 
 /** @addtogroup SURF_plugin_energy
- *
- *
- *  This is the energy plugin, enabling to account not only for computation time, but also for the dissipated energy in the simulated platform.
+
+
+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);
@@ -23,19 +56,32 @@ static void energyCpuCreatedCallback(CpuPtr cpu){
   (*surf_energy)[cpu] = new CpuEnergy(cpu);
 }
 
-static void update_consumption(CpuPtr cpu, CpuEnergyPtr cpu_energy) {
+static void update_consumption_running(CpuPtr cpu, CpuEnergyPtr 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 current_energy = cpu_energy->total_energy;
-       double action_energy = cpu_energy->getCurrentWattsValue(cpu_load)*(finish_time-start_time);
+       double previous_energy = cpu_energy->total_energy;
+       double energy_this_step = cpu_energy->getCurrentWattsValue(cpu_load)*(finish_time-start_time);
 
-       cpu_energy->total_energy = current_energy + action_energy;
+       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, current_energy, action_energy);
+                 start_time, finish_time, cpu->m_powerPeak, previous_energy, energy_this_step);
+}
+static void update_consumption_off(CpuPtr cpu, CpuEnergyPtr cpu_energy) {
+       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->watts_off*(finish_time-start_time);
+
+       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(CpuPtr cpu){
@@ -43,7 +89,10 @@ static void energyCpuDestructedCallback(CpuPtr cpu){
   xbt_assert(cpu_energy_it != surf_energy->end(), "The cpu is not in surf_energy.");
 
   CpuEnergyPtr cpu_energy = cpu_energy_it->second;
-  update_consumption(cpu, cpu_energy);
+  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;
@@ -55,7 +104,18 @@ static void energyCpuActionStateChangedCallback(CpuActionPtr action, e_surf_acti
   CpuEnergyPtr cpu_energy = (*surf_energy)[cpu];
 
   if(cpu_energy->last_updated < surf_get_clock()) {
-         update_consumption(cpu, cpu_energy);
+         update_consumption_running(cpu, cpu_energy);
+  }
+}
+
+static void energyStateChangedCallback(CpuPtr cpu, e_surf_resource_state_t oldState, e_surf_resource_state_t newState){
+  CpuEnergyPtr cpu_energy = (*surf_energy)[cpu];
+
+  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);
   }
 }
 
@@ -67,7 +127,7 @@ static void sg_energy_plugin_exit()
 
 /** \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) {
@@ -76,6 +136,7 @@ void sg_energy_plugin_init() {
     surf_callback_connect(cpuDestructedCallbacks, energyCpuDestructedCallback);
     surf_callback_connect(cpuActionStateChangedCallbacks, energyCpuActionStateChangedCallback);
     surf_callback_connect(surfExitCallbacks, sg_energy_plugin_exit);
+    surf_callback_connect(cpuStateChangedCallbacks, energyStateChangedCallback);
   }
 }
 
@@ -88,6 +149,15 @@ CpuEnergy::CpuEnergy(CpuPtr 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(){
@@ -98,7 +168,6 @@ CpuEnergy::~CpuEnergy(){
   xbt_dynar_free(&power_range_watts_list);
 }
 
-
 /**
  * Computes the power consumed by the host according to the current pstate and processor load
  *
@@ -135,6 +204,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;
 }