Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
put all of the host_energy plugin in one file only
[simgrid.git] / src / surf / plugins / energy.cpp
diff --git a/src/surf/plugins/energy.cpp b/src/surf/plugins/energy.cpp
deleted file mode 100644 (file)
index c063cd3..0000000
+++ /dev/null
@@ -1,314 +0,0 @@
-/* Copyright (c) 2010, 2012-2016. 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. */
-
-#include "simgrid/plugins/energy.h"
-#include "simgrid/simix.hpp"
-#include "src/plugins/vm/VirtualMachineImpl.hpp"
-#include "src/surf/cpu_interface.hpp"
-#include "src/surf/plugins/energy.hpp"
-#include <utility>
-
-/** @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.
-
-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(), 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");
-
-using simgrid::energy::HostEnergy;
-
-namespace simgrid {
-namespace energy {
-
-simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
-
-/* Computes the consumption so far.  Called lazily on need. */
-void HostEnergy::update()
-{
-  double start_time = this->last_updated;
-  double finish_time = surf_get_clock();
-  double cpu_load;
-  if (host->pimpl_cpu->getPstateSpeedCurrent() <= 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()) / host->pimpl_cpu->getPstateSpeedCurrent();
-
-  /** 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 (host->isOff())
-    instantaneous_consumption = this->watts_off;
-  else
-    instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
-
-  double energy_this_step = instantaneous_consumption*(finish_time-start_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);
-}
-
-HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) : host(ptr), last_updated(surf_get_clock())
-{
-  initWattsRangeList();
-
-  const char* off_power_str = host->property("watt_off");
-  if (off_power_str != nullptr) {
-    char* msg       = bprintf("Invalid value for property watt_off of host %s: %%s", host->cname());
-    this->watts_off = xbt_str_parse_double(off_power_str, msg);
-    xbt_free(msg);
-  }
-  /* watts_off is 0 by default */
-}
-
-HostEnergy::~HostEnergy()=default;
-
-double HostEnergy::getWattMinAt(int pstate)
-{
-  xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->cname());
-  return power_range_watts_list[pstate].min;
-}
-
-double HostEnergy::getWattMaxAt(int pstate)
-{
-  xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->cname());
-  return power_range_watts_list[pstate].max;
-}
-
-/** @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->cname());
-
-  /* min_power corresponds to the idle power (cpu load = 0) */
-  /* max_power is the power consumed at 100% cpu load       */
-  auto range           = power_range_watts_list.at(host->pstate());
-  double current_power = 0;
-  double min_power     = 0;
-  double max_power     = 0;
-  double power_slope   = 0;
-
-  if (cpu_load > 0) { /* Something is going on, the machine is not idle */
-    double min_power = range.min;
-    double max_power = range.max;
-
-    /**
-     * The min_power states how much we consume when only one single
-     * core is working. This means that when cpu_load == 1/coreCount, then
-     * current_power == min_power.
-     *
-     * The maximum must be reached when all cores are working (but 1 core was
-     * already accounted for by min_power)
-     * i.e., we need min_power + (maxCpuLoad-1/coreCount)*power_slope == max_power
-     * (maxCpuLoad is by definition 1)
-     */
-    double power_slope;
-    int coreCount = host->coreCount();
-    double coreReciprocal = static_cast<double>(1) / static_cast<double>(coreCount);
-    if (coreCount > 1)
-      power_slope = (max_power - min_power) / (1 - coreReciprocal);
-    else
-      power_slope = 0; // Should be 0, since max_power == min_power (in this case)
-
-    current_power = min_power + (cpu_load - coreReciprocal) * power_slope;
-  }
-  else { /* Our machine is idle, take the dedicated value! */
-    current_power = range.idle;
-  }
-
-  XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
-  XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
-
-  return current_power;
-}
-
-double HostEnergy::getConsumedEnergy()
-{
-  if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
-    simgrid::simix::kernelImmediate(std::bind(&HostEnergy::update, this));
-
-  return total_energy;
-}
-
-void HostEnergy::initWattsRangeList()
-{
-  const char* all_power_values_str = host->property("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++) {
-    /* 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) == 3,
-               "Power properties incorrectly defined - could not retrieve idle, min and max power values for host %s",
-               host->cname());
-
-    /* min_power corresponds to the idle power (cpu load = 0) */
-    /* max_power is the power consumed at 100% cpu load       */
-    char* msg_idle = bprintf("Invalid idle value for pstate %d on host %s: %%s", i, host->cname());
-    char* msg_min  = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->cname());
-    char* msg_max  = bprintf("Invalid max value for pstate %d on host %s: %%s", i, host->cname());
-    PowerRange range(
-      xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*), msg_idle),
-      xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*), msg_min),
-      xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 2, char*), msg_max)
-    );
-    power_range_watts_list.push_back(range);
-    xbt_free(msg_idle);
-    xbt_free(msg_min);
-    xbt_free(msg_max);
-
-    xbt_dynar_free(&current_power_values);
-  }
-  xbt_dynar_free(&all_power_values);
-}
-
-}
-}
-
-/* **************************** events  callback *************************** */
-static void onCreation(simgrid::s4u::Host& host) {
-  if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
-    return;
-  host.extension_set(new HostEnergy(&host));
-}
-
-static void onActionStateChange(simgrid::surf::CpuAction *action, simgrid::surf::Action::State previous) {
-  for (simgrid::surf::Cpu* cpu : action->cpus()) {
-    simgrid::s4u::Host* host = cpu->getHost();
-    if (host == nullptr)
-      continue;
-
-    // If it's a VM, take the corresponding PM
-    simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
-    if (vm) // If it's a VM, take the corresponding PM
-      host = vm->pimpl_vm_->getPm();
-
-    // Get the host_energy extension for the relevant host
-    HostEnergy* host_energy = host->extension<HostEnergy>();
-
-    if (host_energy->last_updated < surf_get_clock())
-      host_energy->update();
-  }
-}
-
-static void onHostStateChange(simgrid::s4u::Host &host) {
-  if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
-    return;
-
-  HostEnergy *host_energy = host.extension<HostEnergy>();
-
-  if(host_energy->last_updated < surf_get_clock())
-    host_energy->update();
-}
-
-static void onHostDestruction(simgrid::s4u::Host& host) {
-  if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
-    return;
-
-  HostEnergy *host_energy = host.extension<HostEnergy>();
-  host_energy->update();
-  XBT_INFO("Total energy of host %s: %f Joules", host.cname(), host_energy->getConsumedEnergy());
-}
-
-/* **************************** Public interface *************************** */
-/** \ingroup SURF_plugin_energy
- * \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_host_energy_plugin_init()
-{
-  if (HostEnergy::EXTENSION_ID.valid())
-    return;
-
-  HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
-
-  simgrid::s4u::Host::onCreation.connect(&onCreation);
-  simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
-  simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
-  simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
-}
-
-/** @brief Returns the total energy consumed by the host so far (in Joules)
- *
- *  See also @ref SURF_plugin_energy.
- */
-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.");
-  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.");
-  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.");
-  return host->extension<HostEnergy>()->getWattMaxAt(pstate);
-}