Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[doc] fix a broken link
[simgrid.git] / src / surf / plugins / energy.cpp
index c0aa357..1c60ba4 100644 (file)
@@ -5,7 +5,6 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include <utility>
-#include <vector>
 
 #include "simgrid/plugins/energy.h"
 #include "simgrid/simix.hpp"
@@ -30,7 +29,8 @@ The energy consumption of a CPU depends directly of its current load. Specify th
 
 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).
+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.
 
@@ -42,18 +42,19 @@ If your CPU is using pstates, then you can provide one consumption interval per
 \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.
+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(), simgrid#s4u#Host#set_pstate(), #MSG_host_get_power_peak_at().
+To change the pstate of a given CPU, use the following functions:
+#MSG_host_get_nb_pstates(), simgrid#s4u#Host#setPstate(), #MSG_host_get_power_peak_at().
 
 To simulate the energy-related elements, first call the simgrid#energy#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_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
-                                "Logging specific to the SURF energy plugin");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
 
 using simgrid::energy::HostEnergy;
 
@@ -69,13 +70,12 @@ void HostEnergy::update()
   double start_time = this->last_updated;
   double finish_time = surf_get_clock();
   double cpu_load;
-  if (surf_host->p_cpu->speed_.peak == 0)
-    // Some users declare a pstate of speed 0 flops (eg to model boot time).
+  if (surf_host->cpu_->speed_.peak <= 0)
+    // Some users declare a pstate of speed 0 flops (e.g., to model boot time).
     // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
     cpu_load = 1;
   else
-    cpu_load = lmm_constraint_get_usage(surf_host->p_cpu->getConstraint())
-                / surf_host->p_cpu->speed_.peak;
+    cpu_load = lmm_constraint_get_usage(surf_host->cpu_->getConstraint()) / surf_host->cpu_->speed_.peak;
 
   if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not mores
     cpu_load = 1;
@@ -94,48 +94,43 @@ void HostEnergy::update()
   this->last_updated = finish_time;
 
   XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
-      surf_host->getName(), start_time, finish_time, surf_host->p_cpu->speed_.peak, previous_energy, energy_this_step);
+      surf_host->getName(), start_time, finish_time, surf_host->cpu_->speed_.peak, previous_energy, energy_this_step);
 }
 
-HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) :
-  host(ptr), last_updated(surf_get_clock())
+HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) : host(ptr), last_updated(surf_get_clock())
 {
   initWattsRangeList();
 
-  if (host->properties() != NULL) {
+  if (host->properties() != nullptr) {
     char* off_power_str = (char*)xbt_dict_get_or_null(host->properties(), "watt_off");
-    if (off_power_str != NULL)
-      watts_off = xbt_str_parse_double(off_power_str,
-          bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str()));
+    if (off_power_str != nullptr) {
+      char *msg = bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str());
+      watts_off = xbt_str_parse_double(off_power_str, msg);
+      xbt_free(msg);
+    }
     else
       watts_off = 0;
   }
-
 }
 
-HostEnergy::~HostEnergy()
-{
-}
+HostEnergy::~HostEnergy()=default;
 
 double HostEnergy::getWattMinAt(int pstate)
 {
-  xbt_assert(!power_range_watts_list.empty(),
-    "No power range properties specified for host %s", host->name().c_str());
+  xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
   return power_range_watts_list[pstate].first;
 }
 
 double HostEnergy::getWattMaxAt(int pstate)
 {
-  xbt_assert(!power_range_watts_list.empty(),
-    "No power range properties specified for host %s", host->name().c_str());
+  xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
   return power_range_watts_list[pstate].second;
 }
 
 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
 double HostEnergy::getCurrentWattsValue(double cpu_load)
 {
-  xbt_assert(!power_range_watts_list.empty(),
-    "No power range properties specified for host %s", host->name().c_str());
+  xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
 
   /* min_power corresponds to the idle power (cpu load = 0) */
   /* max_power is the power consumed at 100% cpu load       */
@@ -154,40 +149,39 @@ double HostEnergy::getCurrentWattsValue(double cpu_load)
 double HostEnergy::getConsumedEnergy()
 {
   if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
-    simgrid::simix::kernel(std::bind(&HostEnergy::update, this));
+    simgrid::simix::kernelImmediate(std::bind(&HostEnergy::update, this));
 
   return total_energy;
 }
 
 void HostEnergy::initWattsRangeList()
 {
-  if (host->properties() == NULL)
+  if (host->properties() == nullptr)
     return;
-  char* all_power_values_str =
-    (char*)xbt_dict_get_or_null(host->properties(), "watt_per_state");
-  if (all_power_values_str == NULL)
+  char* all_power_values_str = static_cast<char*>(xbt_dict_get_or_null(host->properties(), "watt_per_state"));
+  if (all_power_values_str == nullptr)
     return;
 
   xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
   int pstate_nb = xbt_dynar_length(all_power_values);
 
-  for (int i=0; i< pstate_nb; i++)
-  {
+  for (int i=0; i< pstate_nb; i++) {
     /* retrieve the power values associated with the current pstate */
     xbt_dynar_t current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
     xbt_assert(xbt_dynar_length(current_power_values) > 1,
-        "Power properties incorrectly defined - "
-        "could not retrieve min and max power values for host %s",
+        "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
         host->name().c_str());
 
     /* min_power corresponds to the idle power (cpu load = 0) */
     /* max_power is the power consumed at 100% cpu load       */
+    char *msg_min = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
+    char *msg_max = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
     power_range_watts_list.push_back(power_range(
-      xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*),
-          bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str())),
-      xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*),
-          bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str()))
+      xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*), msg_min),
+      xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*), msg_max)
     ));
+    xbt_free(msg_min);
+    xbt_free(msg_max);
 
     xbt_dynar_free(&current_power_values);
   }
@@ -205,19 +199,18 @@ static void onCreation(simgrid::s4u::Host& host) {
   host.extension_set(new HostEnergy(&host));
 }
 
-static void onActionStateChange(simgrid::surf::CpuAction *action, e_surf_action_state_t previous) {
-  std::list<simgrid::surf::Cpu*> cpus = getActionCpus(action);
-  for(simgrid::surf::Cpu* cpu : cpus) {
+static void onActionStateChange(simgrid::surf::CpuAction *action, simgrid::surf::Action::State previous) {
+  for(simgrid::surf::Cpu* cpu : action->cpus()) {
     const char *name = cpu->getName();
     sg_host_t sghost = sg_host_by_name(name);
-    if(sghost == NULL)
+    if(sghost == nullptr)
       continue;
     simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
     simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
     if (vm) // If it's a VM, take the corresponding PM
       host = vm->getPm()->extension<simgrid::surf::HostImpl>();
 
-    HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
+    HostEnergy *host_energy = host->piface_->extension<HostEnergy>();
 
     if(host_energy->last_updated < surf_get_clock())
       host_energy->update();
@@ -242,8 +235,7 @@ static void onHostDestruction(simgrid::s4u::Host& host) {
     return;
   HostEnergy *host_energy = host.extension<HostEnergy>();
   host_energy->update();
-  XBT_INFO("Total energy of host %s: %f Joules",
-    host.name().c_str(), host_energy->getConsumedEnergy());
+  XBT_INFO("Total energy of host %s: %f Joules", host.name().c_str(), host_energy->getConsumedEnergy());
 }
 
 /* **************************** Public interface *************************** */
@@ -251,7 +243,7 @@ static void onHostDestruction(simgrid::s4u::Host& host) {
  * \brief Enable energy plugin
  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
  */
-void sg_energy_plugin_init(void)
+void sg_energy_plugin_init()
 {
   if (HostEnergy::EXTENSION_ID.valid())
     return;
@@ -270,22 +262,19 @@ void sg_energy_plugin_init(void)
  */
 double sg_host_get_consumed_energy(sg_host_t host) {
   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
-    "The Energy plugin is not active. "
-    "Please call sg_energy_plugin_init() during initialization.");
+    "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
   return host->extension<HostEnergy>()->getConsumedEnergy();
 }
 
 /** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
 double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
-    "The Energy plugin is not active. "
-    "Please call sg_energy_plugin_init() during initialization.");
+    "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
   return host->extension<HostEnergy>()->getWattMinAt(pstate);
 }
 /** @brief  Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
 double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
-    "The Energy plugin is not active. "
-    "Please call sg_energy_plugin_init() during initialization.");
+    "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
   return host->extension<HostEnergy>()->getWattMaxAt(pstate);
 }