src/plugins/host_load.cpp

   1 /* Copyright (c) 2010-2018. 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 "src/plugins/vm/VirtualMachineImpl.hpp"
   8
   9 /** @addtogroup plugin_load
  10
  11 This plugin makes it very simple for users to obtain the current load for each host.
  12
  13 */
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the HostLoad plugin");
  16
  17 namespace simgrid {
  18 namespace plugin {
  19
  20 class HostLoad {
  21 public:
  22   static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
  23
  24   explicit HostLoad(simgrid::s4u::Host* ptr)
  25       : host_(ptr)
  26       , last_updated_(surf_get_clock())
  27       , last_reset_(surf_get_clock())
  28       , current_speed_(host_->getSpeed())
  29       , current_flops_(host_->pimpl_cpu->get_constraint()->get_usage())
  30       , theor_max_flops_(0)
  31       , was_prev_idle_(current_flops_ == 0)
  32   {
  33   }
  34   ~HostLoad() = default;
  35
  36   double get_current_load();
  37   double get_average_load() { return (theor_max_flops_ == 0) ? 0 : computed_flops_ / theor_max_flops_; };
  38   double get_computed_flops() { return computed_flops_; }
  39   double get_idle_time() { return idle_time_; } /** Return idle time since last reset */
  40   void update();
  41   void reset();
  42
  43 private:
  44   simgrid::s4u::Host* host_ = nullptr;
  45   double last_updated_      = 0;
  46   double last_reset_        = 0;
  47   /**
  48    * current_speed each core is running at right now
  49    */
  50   double current_speed_     = 0;
  51   /**
  52    * How many flops are currently used by all the processes running on this
  53    * host?
  54    */
  55   double current_flops_     = 0;
  56   double computed_flops_    = 0;
  57   double idle_time_         = 0;
  58   double theor_max_flops_   = 0;
  59   bool was_prev_idle_       = true; /* A host is idle at the beginning */
  60 };
  61
  62 simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
  63
  64 void HostLoad::update()
  65 {
  66   double now = surf_get_clock();
  67
  68   /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k \in {0, 1, ..., cores}
  69    * number of active cores */
  70   current_flops_ = host_->pimpl_cpu->get_constraint()->get_usage();
  71
  72   /* flops == pstate_speed * cores_being_currently_used */
  73   computed_flops_ += (now - last_updated_) * current_flops_;
  74
  75   if (was_prev_idle_) {
  76     idle_time_ += (now - last_updated_);
  77   }
  78
  79   theor_max_flops_ += current_speed_ * host_->get_core_count() * (now - last_updated_);
  80   current_speed_ = host_->getSpeed();
  81   last_updated_  = now;
  82   was_prev_idle_ = (current_flops_ == 0);
  83 }
  84
  85 /**
  86  * WARNING: This function does not guarantee that you have the real load at any time imagine all actions on your CPU
  87  * terminate at time t. Your load is then 0. Then you query the load (still 0) and then another action starts (still at
  88  * time t!). This means that the load was never really 0 (because the time didn't advance) but it will still be reported
  89  * as 0.
  90  *
  91  * So, use at your own risk.
  92  */
  93 double HostLoad::get_current_load()
  94 {
  95   // We don't need to call update() here because it is called every time an action terminates or starts
  96   // FIXME: Can this happen at the same time? stop -> call to getCurrentLoad, load = 0 -> next action starts?
  97   return current_flops_ / static_cast<double>(host_->getSpeed() * host_->get_core_count());
  98 }
  99
 100 /*
 101  * Resets the counters
 102  */
 103 void HostLoad::reset()
 104 {
 105   last_updated_    = surf_get_clock();
 106   last_reset_      = surf_get_clock();
 107   idle_time_       = 0;
 108   computed_flops_  = 0;
 109   theor_max_flops_ = 0;
 110   current_flops_   = host_->pimpl_cpu->get_constraint()->get_usage();
 111   current_speed_   = host_->getSpeed();
 112   was_prev_idle_   = (current_flops_ == 0);
 113 }
 114 } // namespace plugin
 115 } // namespace simgrid
 116
 117 using simgrid::plugin::HostLoad;
 118
 119 /* **************************** events  callback *************************** */
 120 /* This callback is fired either when the host changes its state (on/off) or its speed
 121  * (because the user changed the pstate, or because of external trace events) */
 122 static void on_host_change(simgrid::s4u::Host& host)
 123 {
 124   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 125     return;
 126
 127   host.extension<HostLoad>()->update();
 128 }
 129
 130 /* This callback is called when an action (computation, idle, ...) terminates */
 131 static void on_action_state_change(simgrid::surf::CpuAction* action)
 132 {
 133   for (simgrid::surf::Cpu* const& cpu : action->cpus()) {
 134     simgrid::s4u::Host* host = cpu->get_host();
 135
 136     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host)) // Ignore virtual machines
 137       return;
 138
 139     if (host != nullptr) {
 140       host->extension<HostLoad>()->update();
 141     }
 142   }
 143 }
 144
 145 /* **************************** Public interface *************************** */
 146
 147 /** \ingroup plugin_load
 148  * \brief Initializes the HostLoad plugin
 149  * \details The HostLoad plugin provides an API to get the current load of each host.
 150  */
 151 void sg_host_load_plugin_init()
 152 {
 153   if (HostLoad::EXTENSION_ID.valid())
 154     return;
 155
 156   HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
 157
 158   /* When attaching a callback into a signal, you can use a lambda as follows, or a regular function as done below */
 159
 160   simgrid::s4u::Host::on_creation.connect([](simgrid::s4u::Host& host) {
 161     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 162       return;
 163     host.extension_set(new HostLoad(&host));
 164   });
 165
 166   simgrid::surf::CpuAction::on_state_change.connect(&on_action_state_change);
 167   simgrid::s4u::Host::on_state_change.connect(&on_host_change);
 168   simgrid::s4u::Host::on_speed_change.connect(&on_host_change);
 169 }
 170
 171 /** @brief Returns the current load of the host passed as argument
 172  *
 173  *  See also @ref plugin_load
 174  */
 175 double sg_host_get_current_load(sg_host_t host)
 176 {
 177   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 178              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 179
 180   return host->extension<HostLoad>()->get_current_load();
 181 }
 182
 183 /** @brief Returns the current load of the host passed as argument
 184  *
 185  *  See also @ref plugin_load
 186  */
 187 double sg_host_get_avg_load(sg_host_t host)
 188 {
 189   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 190              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 191
 192   return host->extension<HostLoad>()->get_average_load();
 193 }
 194
 195 /** @brief Returns the time this host was idle since the last reset
 196  *
 197  *  See also @ref plugin_load
 198  */
 199 double sg_host_get_idle_time(sg_host_t host)
 200 {
 201   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 202              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 203
 204   return host->extension<HostLoad>()->get_idle_time();
 205 }
 206
 207 double sg_host_get_computed_flops(sg_host_t host)
 208 {
 209   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 210              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 211
 212   return host->extension<HostLoad>()->get_computed_flops();
 213 }
 214
 215 void sg_host_load_reset(sg_host_t host)
 216 {
 217   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 218              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 219
 220   host->extension<HostLoad>()->reset();
 221 }