src/surf/plugins/host_load.cpp

   1 /* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/plugins/load.h"
   7 #include "simgrid/simix.hpp"
   8 #include "src/plugins/vm/VirtualMachineImpl.hpp"
   9 #include "src/surf/cpu_interface.hpp"
  10
  11 #include "simgrid/s4u/Engine.hpp"
  12
  13 #include <boost/algorithm/string/classification.hpp>
  14 #include <boost/algorithm/string/split.hpp>
  15 #include <string>
  16 #include <utility>
  17 #include <vector>
  18
  19 /** @addtogroup plugin_load
  20
  21 This plugin makes it very simple for users to obtain the current load for each host.
  22
  23 */
  24
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the HostLoad plugin");
  26
  27 namespace simgrid {
  28 namespace plugin {
  29
  30 class HostLoad {
  31 public:
  32   static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
  33
  34   explicit HostLoad(simgrid::s4u::Host* ptr);
  35   ~HostLoad();
  36
  37   double getCurrentLoad();
  38   double getComputedFlops();
  39   double getAverageLoad();
  40   double getIdleTime();
  41   void update();
  42   void reset();
  43
  44 private:
  45   simgrid::s4u::Host* host = nullptr;
  46   double last_updated      = 0;
  47   double last_reset        = 0;
  48   double current_speed     = 0;
  49   double current_flops     = 0;
  50   double computed_flops    = 0;
  51   double idle_time         = 0;
  52   long   theor_max_flops   = 0;
  53   bool   was_prev_idle     = true; /* A host is idle at the beginning */
  54 };
  55
  56 simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
  57
  58 HostLoad::HostLoad(simgrid::s4u::Host* ptr)
  59     : host(ptr)
  60     , last_updated(surf_get_clock())
  61     , last_reset(surf_get_clock())
  62     , current_speed(host->getSpeed())
  63     , current_flops(host->pimpl_cpu->constraint()->get_usage())
  64     , theor_max_flops(0)
  65     , was_prev_idle(current_flops == 0)
  66 {
  67 }
  68
  69 HostLoad::~HostLoad() = default;
  70
  71 void HostLoad::update()
  72 {
  73   double now = surf_get_clock();
  74   if (last_updated < now) {
  75     /* flops == pstate_speed * cores_being_currently_used */
  76     computed_flops += (now - last_updated) * current_flops;
  77
  78     /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k \in {0, 1, ..., cores}
  79      * number of active cores */
  80     current_flops = host->pimpl_cpu->constraint()->get_usage();
  81
  82     if (was_prev_idle) {
  83       idle_time += (now - last_updated);
  84     }
  85
  86     theor_max_flops += current_speed * host->getCoreCount() * (now - last_updated);
  87     current_speed    = host->getSpeed();
  88     last_updated     = now;
  89     was_prev_idle    = (current_flops == 0);
  90   }
  91 }
  92
  93 double HostLoad::getCurrentLoad()
  94 {
  95   return current_flops / static_cast<double>(host->getSpeed() * host->getCoreCount());
  96 }
  97
  98 /**
  99  * Return idle time since last reset
 100  */
 101 double HostLoad::getIdleTime() {
 102   return idle_time;
 103 }
 104
 105 double HostLoad::getAverageLoad()
 106 {
 107   return getComputedFlops() / (host->getSpeed() * host->getCoreCount() * (surf_get_clock() - last_reset));
 108 }
 109
 110 double HostLoad::getComputedFlops()
 111 {
 112   update();
 113
 114   return computed_flops;
 115 }
 116
 117 /*
 118  * Resets the counters
 119  */
 120 void HostLoad::reset()
 121 {
 122   last_updated   = surf_get_clock();
 123   last_reset     = surf_get_clock();
 124   computed_flops = 0;
 125 }
 126 }
 127 }
 128
 129 using simgrid::plugin::HostLoad;
 130
 131 /* **************************** events  callback *************************** */
 132 /* This callback is fired either when the host changes its state (on/off) or its speed
 133  * (because the user changed the pstate, or because of external trace events) */
 134 static void onHostChange(simgrid::s4u::Host& host)
 135 {
 136   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 137     return;
 138
 139   host.extension<HostLoad>()->update();
 140 }
 141
 142 /* This callback is called when an action (computation, idle, ...) terminates */
 143 static void onActionStateChange(simgrid::surf::CpuAction* action, simgrid::surf::Action::State /*previous*/)
 144 {
 145   for (simgrid::surf::Cpu* const& cpu : action->cpus()) {
 146     simgrid::s4u::Host* host = cpu->getHost();
 147
 148     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host)) // Ignore virtual machines
 149       return;
 150
 151     if (host != nullptr) {
 152       host->extension<HostLoad>()->update();
 153     }
 154   }
 155 }
 156
 157 /* **************************** Public interface *************************** */
 158 extern "C" {
 159
 160 /** \ingroup plugin_load
 161  * \brief Initializes the HostLoad plugin
 162  * \details The HostLoad plugin provides an API to get the current load of each host.
 163  */
 164 void sg_host_load_plugin_init()
 165 {
 166   if (HostLoad::EXTENSION_ID.valid())
 167     return;
 168
 169   HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
 170
 171   /* When attaching a callback into a signal, you can use a lambda as follows, or a regular function as done below */
 172
 173   simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
 174     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 175       return;
 176     host.extension_set(new HostLoad(&host));
 177   });
 178
 179   simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
 180   simgrid::s4u::Host::onStateChange.connect(&onHostChange);
 181   simgrid::s4u::Host::onSpeedChange.connect(&onHostChange);
 182 }
 183
 184 /** @brief Returns the current load of the host passed as argument
 185  *
 186  *  See also @ref plugin_load
 187  */
 188 double sg_host_get_current_load(sg_host_t host)
 189 {
 190   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 191              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 192
 193   return host->extension<HostLoad>()->getCurrentLoad();
 194 }
 195
 196 /** @brief Returns the current load of the host passed as argument
 197  *
 198  *  See also @ref plugin_load
 199  */
 200 double sg_host_get_avg_load(sg_host_t host)
 201 {
 202   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 203              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 204
 205   return host->extension<HostLoad>()->getAverageLoad();
 206 }
 207
 208 /** @brief Returns the time this host was idle since the last reset
 209  *
 210  *  See also @ref plugin_load
 211  */
 212 double sg_host_get_idle_time(sg_host_t host)
 213 {
 214   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 215              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 216
 217   return host->extension<HostLoad>()->getIdleTime();
 218 }
 219
 220 double sg_host_get_computed_flops(sg_host_t host)
 221 {
 222   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 223              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 224
 225   return host->extension<HostLoad>()->getComputedFlops();
 226 }
 227
 228 void sg_host_load_reset(sg_host_t host)
 229 {
 230   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 231              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 232
 233   host->extension<HostLoad>()->reset();
 234 }
 235 }