src/plugins/host_load.cpp

   1 /* Copyright (c) 2010-2023. 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/s4u/Engine.hpp>
   8 #include <simgrid/s4u/Exec.hpp>
   9 #include <simgrid/s4u/Host.hpp>
  10 #include <simgrid/s4u/VirtualMachine.hpp>
  11
  12 #include "src/kernel/activity/ExecImpl.hpp"
  13 #include "src/simgrid/module.hpp" // SIMGRID_REGISTER_PLUGIN
  14
  15 // Makes sure that this plugin can be activated from the command line with ``--cfg=plugin:host_load``
  16 SIMGRID_REGISTER_PLUGIN(host_load, "Cpu load", &sg_host_load_plugin_init)
  17
  18 /** @defgroup plugin_host_load Simple plugin that monitors the current load for each host.
  19
  20   @beginrst
  21 In addition, this constitutes a good introductory example on how to write a plugin.
  22 It attaches an extension to each host to store some data, and places callbacks in the following signals:
  23
  24   - :cpp:func:`simgrid::s4u::Host::on_creation_cb`: Attach a new extension to the newly created host.
  25   - :cpp:func:`simgrid::s4u::Exec::on_start_cb`: Make note that a new execution started, increasing the load.
  26   - :cpp:func:`simgrid::s4u::Exec::on_completion_cb`: Make note that an execution completed, decreasing the load.
  27   - :cpp:func:`simgrid::s4u::Host::on_state_change_cb`: Do what is appropriate when the host gets suspended, turned off
  28     or similar.
  29   - :cpp:func:`simgrid::s4u::Host::on_speed_change_cb`: Do what is appropriate when the DVFS is modified.
  30
  31   Note that extensions are automatically destroyed when the host gets destroyed.
  32   @endrst
  33 */
  34
  35 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(host_load, plugin, "Logging specific to the HostLoad plugin");
  36
  37 namespace simgrid::plugin {
  38
  39 static const double activity_uninitialized_remaining_cost = -1;
  40
  41 /** This class stores the extra data needed by this plugin about a given host
  42  *
  43  * It is stored as an extension of s4u::Host. Such extensions are retrieved by type as follows:
  44  *
  45  * @verbatim
  46  * simgrid::s4u::Host* this_host = ???;
  47  * this_extension = host->extension<HostLoad>();
  48  * @endverbatim
  49  *
  50  * If no extension of that type was ever attached to the inspected object, the ``extension<X>()`` template returns
  51  * nullptr.
  52  *
  53  * Please refer to the implementation of ``sg_host_load_plugin_init()`` to see the extension objects are attached to
  54  * hosts at initialization time.
  55  */
  56 class HostLoad {
  57 public:
  58   static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
  59
  60   explicit HostLoad(simgrid::s4u::Host* ptr)
  61       : host_(ptr)
  62       , last_updated_(simgrid_get_clock())
  63       , last_reset_(simgrid_get_clock())
  64       , current_speed_(host_->get_speed())
  65       , current_flops_(host_->get_load())
  66   {
  67   }
  68   HostLoad() = delete;
  69   explicit HostLoad(simgrid::s4u::Host& ptr) = delete;
  70   explicit HostLoad(simgrid::s4u::Host&& ptr) = delete;
  71
  72   double get_current_load() const;
  73   /** Get the the average load since last reset(), as a ratio
  74    *
  75    * That's the ratio (amount of flops that were actually computed) / (amount of flops that could have been computed at full speed)
  76    */
  77   double get_average_load() { update(); return (theor_max_flops_ == 0) ? 0 : computed_flops_ / theor_max_flops_; };
  78   /** Amount of flops computed since last reset() */
  79   double get_computed_flops() { update(); return computed_flops_; }
  80   /** Return idle time since last reset() */
  81   double get_idle_time() { update(); return idle_time_; }
  82   /** Return idle time over the whole simulation */
  83   double get_total_idle_time() { update(); return total_idle_time_; }
  84   void update();
  85   void add_activity(simgrid::kernel::activity::ExecImpl* activity);
  86   void reset();
  87
  88 private:
  89   simgrid::s4u::Host* host_ = nullptr;
  90   /* Stores all currently ongoing activities (computations) on this machine */
  91   std::map<simgrid::kernel::activity::ExecImpl*, /* cost still remaining*/ double> current_activities;
  92   double last_updated_      = 0;
  93   double last_reset_        = 0;
  94   /**
  95    * current_speed each core is running at; we need to store this as the speed
  96    * will already have changed once we get notified
  97    */
  98   double current_speed_     = 0;
  99   /**
 100    * How many flops are currently used by all the processes running on this
 101    * host?
 102    */
 103   double current_flops_     = 0;
 104   double computed_flops_    = 0;
 105   double idle_time_         = 0;
 106   double total_idle_time_   = 0; /* This updated but never gets reset */
 107   double theor_max_flops_   = 0;
 108 };
 109
 110 // Create the static field that the extension mechanism needs
 111 simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
 112
 113 void HostLoad::add_activity(simgrid::kernel::activity::ExecImpl* activity)
 114 {
 115   current_activities.insert({activity, activity_uninitialized_remaining_cost});
 116 }
 117
 118 void HostLoad::update()
 119 {
 120   double now = simgrid_get_clock();
 121
 122   // This loop updates the flops that the host executed for the ongoing computations
 123   auto iter = begin(current_activities);
 124   while (iter != end(current_activities)) {
 125     auto& activity                         = iter->first;  // Just an alias
 126     auto& remaining_cost_after_last_update = iter->second; // Just an alias
 127     auto& action                           = activity->model_action_;
 128     auto current_iter                      = iter;
 129     ++iter;
 130
 131     if (action != nullptr && action->get_finish_time() != now &&
 132         activity->get_state() == kernel::activity::State::RUNNING) {
 133       if (remaining_cost_after_last_update == activity_uninitialized_remaining_cost) {
 134         remaining_cost_after_last_update = action->get_cost();
 135       }
 136       double computed_flops_since_last_update = remaining_cost_after_last_update - /*remaining now*/activity->get_remaining();
 137       computed_flops_                        += computed_flops_since_last_update;
 138       remaining_cost_after_last_update        = activity->get_remaining();
 139     } else if (activity->get_state() == kernel::activity::State::DONE) {
 140       computed_flops_ += remaining_cost_after_last_update;
 141       current_activities.erase(current_iter);
 142     }
 143   }
 144
 145   /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k @in {0, 1, ..., cores-1}
 146    * designates number of active cores; will be 0 if CPU is currently idle */
 147   current_flops_ = host_->get_load();
 148
 149   if (current_flops_ == 0) {
 150     idle_time_ += (now - last_updated_);
 151     total_idle_time_ += (now - last_updated_);
 152     XBT_DEBUG("[%s]: Currently idle -> Added %f seconds to idle time (totaling %fs)", host_->get_cname(), (now - last_updated_), idle_time_);
 153   }
 154
 155   theor_max_flops_ += current_speed_ * host_->get_core_count() * (now - last_updated_);
 156   current_speed_ = host_->get_speed();
 157   last_updated_  = now;
 158 }
 159
 160 /** @brief Get the current load as a ratio = achieved_flops / (core_current_speed * core_amount)
 161  *
 162  * You may also want to check simgrid::s4u::Host::get_load() that simply returns
 163  * the achieved flop rate (in flops per seconds), ie the load that a new action arriving on
 164  * that host would suffer.
 165  *
 166  * Please note that this function only returns an instantaneous load that may be deceiving
 167  * in some scenarios. For example, imagine that an activity terminates at time t, and that
 168  * another activity is created on the same host at the exact same timestamp. The load was
 169  * never 0 on the simulated machine since the time did not advance between the two events.
 170  * But still, if you call this function between the two events (in the simulator course), it
 171  * returns 0 although there is no time (in the simulated time) where this value is valid.
 172  */
 173 double HostLoad::get_current_load() const
 174 {
 175   // We don't need to call update() here because it is called every time an action terminates or starts
 176   return current_flops_ / (host_->get_speed() * host_->get_core_count());
 177 }
 178
 179 /*
 180  * Resets the counters
 181  */
 182 void HostLoad::reset()
 183 {
 184   last_updated_    = simgrid_get_clock();
 185   last_reset_      = simgrid_get_clock();
 186   idle_time_       = 0;
 187   computed_flops_  = 0;
 188   theor_max_flops_ = 0;
 189   current_flops_   = host_->get_load();
 190   current_speed_   = host_->get_speed();
 191 }
 192 } // namespace simgrid::plugin
 193
 194 using simgrid::plugin::HostLoad;
 195
 196 /* **************************** events  callback *************************** */
 197 /* This callback is fired either when the host changes its state (on/off) or its speed
 198  * (because the user changed the pstate, or because of external trace events) */
 199 static void on_host_change(simgrid::s4u::Host const& host)
 200 {
 201   if (dynamic_cast<simgrid::s4u::VirtualMachine const*>(&host)) // Ignore virtual machines
 202     return;
 203
 204   host.extension<HostLoad>()->update();
 205 }
 206
 207 /* **************************** Public interface *************************** */
 208
 209 /** @brief Initializes the HostLoad plugin
 210  *  @ingroup plugin_host_load
 211  */
 212 void sg_host_load_plugin_init()
 213 {
 214   if (HostLoad::EXTENSION_ID.valid()) // Don't do the job twice
 215     return;
 216
 217   // First register our extension of Hosts properly
 218   HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
 219
 220   // If SimGrid is already initialized, we need to attach an extension to each existing host
 221   if (simgrid::s4u::Engine::is_initialized()) {
 222     const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
 223     for (auto& host : e->get_all_hosts()) {
 224       host->extension_set(new HostLoad(host));
 225     }
 226   }
 227
 228   // Make sure that every future host also gets an extension (in case the platform is not loaded yet)
 229   simgrid::s4u::Host::on_creation_cb([](simgrid::s4u::Host& host) {
 230     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 231       return;
 232     host.extension_set(new HostLoad(&host));
 233   });
 234
 235   simgrid::s4u::Exec::on_start_cb([](simgrid::s4u::Exec const& activity) {
 236     if (activity.get_host_number() == 1) { // We only run on one host
 237       simgrid::s4u::Host* host         = activity.get_host();
 238       if (const auto* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host))
 239         host = vm->get_pm();
 240       xbt_assert(host != nullptr);
 241       host->extension<HostLoad>()->add_activity(static_cast<simgrid::kernel::activity::ExecImpl*>(activity.get_impl()));
 242       host->extension<HostLoad>()->update(); // If the system was idle until now, we need to update *before*
 243                                              // this computation starts running so we can keep track of the
 244                                              // idle time. (Communication operations don't trigger this hook!)
 245     }
 246     else { // This runs on multiple hosts
 247       XBT_WARN("HostLoad plugin currently does not support executions on several hosts");
 248     }
 249   });
 250   simgrid::s4u::Exec::on_completion_cb([](simgrid::s4u::Exec const& exec) {
 251     if (exec.get_host_number() == 1) { // We only run on one host
 252       simgrid::s4u::Host* host = exec.get_host();
 253       if (const auto* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host))
 254         host = vm->get_pm();
 255       xbt_assert(host != nullptr);
 256       host->extension<HostLoad>()->update();
 257     } else { // This runs on multiple hosts
 258       XBT_WARN("HostLoad plugin currently does not support executions on several hosts");
 259     }
 260   });
 261   simgrid::s4u::Host::on_state_change_cb(&on_host_change);
 262   simgrid::s4u::Host::on_speed_change_cb(&on_host_change);
 263 }
 264
 265 /** @brief Returns the current load of that host, as a ratio = achieved_flops / (core_current_speed * core_amount)
 266  *  @ingroup plugin_host_load
 267  */
 268 double sg_host_get_current_load(const_sg_host_t host)
 269 {
 270   xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin.");
 271
 272   return host->extension<HostLoad>()->get_current_load();
 273 }
 274
 275 /** @brief Returns the current load of that host
 276  *  @ingroup plugin_host_load
 277  */
 278 double sg_host_get_avg_load(const_sg_host_t host)
 279 {
 280   xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin.");
 281
 282   return host->extension<HostLoad>()->get_average_load();
 283 }
 284
 285 /** @brief Returns the time this host was idle since the last reset
 286  *  @ingroup plugin_host_load
 287  */
 288 double sg_host_get_idle_time(const_sg_host_t host)
 289 {
 290   xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin.");
 291
 292   return host->extension<HostLoad>()->get_idle_time();
 293 }
 294
 295 /** @brief Returns the time this host was idle since the beginning of the simulation
 296  *  @ingroup plugin_host_load
 297  */
 298 double sg_host_get_total_idle_time(const_sg_host_t host)
 299 {
 300   xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin.");
 301
 302   return host->extension<HostLoad>()->get_total_idle_time();
 303 }
 304
 305 /** @brief Returns the amount of flops computed by that host since the last reset
 306  *  @ingroup plugin_host_load
 307  */
 308 double sg_host_get_computed_flops(const_sg_host_t host)
 309 {
 310   xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin.");
 311
 312   return host->extension<HostLoad>()->get_computed_flops();
 313 }
 314
 315 /** @brief Resets the idle time and flops amount of that host
 316  *  @ingroup plugin_host_load
 317  */
 318 void sg_host_load_reset(const_sg_host_t host)
 319 {
 320   xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin.");
 321
 322   host->extension<HostLoad>()->reset();
 323 }