Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[ENERGY] Add API call for querying current consumption
[simgrid.git] / src / surf / plugins / host_energy.cpp
index 9a441b9..9698183 100644 (file)
@@ -10,6 +10,7 @@
 
 #include "simgrid/s4u/Engine.hpp"
 
+#include <algorithm>
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
 #include <string>
@@ -113,45 +114,54 @@ void HostEnergy::update()
   double finish_time = surf_get_clock();
   double cpu_load;
   double current_speed = host->speed();
-  if (current_speed <= 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(host->pimpl_cpu->constraint()) / current_speed;
-
-  /** Divide by the number of cores here **/
-  cpu_load /= host->pimpl_cpu->coreCount();
-
-  if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not more
-    cpu_load = 1;
-
-  /* The problem with this model is that the load is always 0 or 1, never something less.
-   * Another possibility could be to model the total energy as
-   *
-   *   X/(X+Y)*W_idle + Y/(X+Y)*W_burn
-   *
-   * where X is the amount of idling cores, and Y the amount of computing cores.
-   */
 
-  double previous_energy = this->total_energy;
+  if (start_time < finish_time) {
+    // We may have start == finish if the past consumption was updated since the simcall was started
+    // for example if 2 actors requested to update the same host's consumption in a given scheduling round.
+    //
+    // Even in this case, we need to save the pstate for the next call (after this big if),
+    // which may have changed since that recent update.
+
+    if (current_speed <= 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(host->pimpl_cpu->constraint()) / current_speed;
+
+    /** Divide by the number of cores here **/
+    cpu_load /= host->pimpl_cpu->coreCount();
+
+    if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not more
+      cpu_load = 1;
+
+    /* The problem with this model is that the load is always 0 or 1, never something less.
+     * Another possibility could be to model the total energy as
+     *
+     *   X/(X+Y)*W_idle + Y/(X+Y)*W_burn
+     *
+     * where X is the amount of idling cores, and Y the amount of computing cores.
+     */
+
+    double previous_energy = this->total_energy;
 
-  double instantaneous_consumption;
-  if (this->pstate == -1) // The host was off at the beginning of this time interval
-    instantaneous_consumption = this->watts_off;
-  else
-    instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
+    double instantaneous_consumption;
+    if (this->pstate == -1) // The host was off at the beginning of this time interval
+      instantaneous_consumption = this->watts_off;
+    else
+      instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
 
-  double energy_this_step = instantaneous_consumption * (finish_time - start_time);
+    double energy_this_step = instantaneous_consumption * (finish_time - start_time);
 
-  //TODO Trace: Trace energy_this_step from start_time to finish_time in host->name()
+    // TODO Trace: Trace energy_this_step from start_time to finish_time in host->name()
 
-  this->total_energy = previous_energy + energy_this_step;
-  this->last_updated = finish_time;
+    this->total_energy = previous_energy + energy_this_step;
+    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",
-      host->cname(), start_time, finish_time, host->pimpl_cpu->speed_.peak, previous_energy, energy_this_step);
+    XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> "
+              "%.2f J",
+              host->cname(), start_time, finish_time, host->pimpl_cpu->speed_.peak, previous_energy, energy_this_step);
+  }
 
   /* Save data for the upcoming time interval: whether it's on/off and the pstate if it's on */
   this->pstate = host->isOn() ? host->pstate() : -1;
@@ -168,6 +178,13 @@ HostEnergy::HostEnergy(simgrid::s4u::Host* ptr) : host(ptr), last_updated(surf_g
     xbt_free(msg);
   }
   /* watts_off is 0 by default */
+
+  if (ptr->coreCount() == 1)
+    xbt_assert(std::all_of(power_range_watts_list.begin(), power_range_watts_list.end(),
+                           [](PowerRange power_range) { return power_range.min == power_range.max; }),
+               "You only have one core in host %s, but the \
+      energy consumption for one core does not match the energy consumption for all (here: 1) cores). This is an error in your platform, please fix it.",
+               host->cname());
 }
 
 HostEnergy::~HostEnergy() = default;
@@ -372,7 +389,26 @@ void sg_host_energy_plugin_init()
   simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
 }
 
+/** @brief updates the consumption of all hosts
+ *
+ * After this call, sg_host_get_consumed_energy() will not interrupt your process
+ * (until after the next clock update).
+ */
+void sg_host_energy_update_all()
+{
+  simgrid::simix::kernelImmediate([]() {
+    std::vector<simgrid::s4u::Host*> list;
+    simgrid::s4u::Engine::instance()->hostList(&list);
+    for (auto host : list)
+      host->extension<HostEnergy>()->update();
+  });
+}
+
 /** @brief Returns the total energy consumed by the host so far (in Joules)
+ *
+ *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
+ *  The result is that the actor requesting this value will be interrupted,
+ *  the value will be updated in kernel mode before returning the control to the requesting actor.
  *
  *  See also @ref SURF_plugin_energy.
  */
@@ -398,4 +434,13 @@ double sg_host_get_wattmax_at(sg_host_t host, int pstate)
   return host->extension<HostEnergy>()->getWattMaxAt(pstate);
 }
 
+/** @brief Returns the current consumption of the host */
+double sg_host_get_current_consumption(sg_host_t host)
+{
+  xbt_assert(HostEnergy::EXTENSION_ID.valid(),
+             "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
+  double cpu_load = lmm_constraint_get_usage(host->pimpl_cpu->constraint()) / host->speed();
+  return host->extension<HostEnergy>()->getCurrentWattsValue(cpu_load);
+}
+
 SG_END_DECL()