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/include/surf/surf.hpp"
   8 #include "src/kernel/activity/ExecImpl.hpp"
   9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  10 #include <simgrid/s4u.hpp>
  11
  12 SIMGRID_REGISTER_PLUGIN(host_load, "Cpu load", &sg_host_load_plugin_init)
  13
  14 /** @addtogroup plugin_load
  15
  16 This plugin makes it very simple for users to obtain the current load for each host.
  17
  18 */
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the HostLoad plugin");
  21
  22 namespace simgrid {
  23 namespace plugin {
  24
  25 static const double activity_uninitialized_remaining_cost = -1;
  26
  27 class HostLoad {
  28 public:
  29   static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
  30
  31   explicit HostLoad(simgrid::s4u::Host* ptr)
  32       : host_(ptr)
  33       , last_updated_(surf_get_clock())
  34       , last_reset_(surf_get_clock())
  35       , current_speed_(host_->get_speed())
  36       , current_flops_(host_->pimpl_cpu->get_constraint()->get_usage())
  37       , theor_max_flops_(0)
  38   {
  39   }
  40   ~HostLoad() = default;
  41   HostLoad() = delete;
  42   explicit HostLoad(simgrid::s4u::Host& ptr) = delete;
  43   explicit HostLoad(simgrid::s4u::Host&& ptr) = delete;
  44
  45   double get_current_load();
  46   double get_average_load() { update(); return (theor_max_flops_ == 0) ? 0 : computed_flops_ / theor_max_flops_; };
  47   double get_computed_flops() { update(); return computed_flops_; }
  48   double get_idle_time() { update(); return idle_time_; } /** Return idle time since last reset */
  49   double get_total_idle_time() { update(); return total_idle_time_; } /** Return idle time over the whole simulation */
  50   void update();
  51   void add_activity(simgrid::kernel::activity::ExecImplPtr activity);
  52   void reset();
  53
  54 private:
  55   simgrid::s4u::Host* host_ = nullptr;
  56   /* Stores all currently ongoing activities (computations) on this machine */
  57   std::map<simgrid::kernel::activity::ExecImplPtr, /* cost still remaining*/double> current_activities;
  58   double last_updated_      = 0;
  59   double last_reset_        = 0;
  60   /**
  61    * current_speed each core is running at; we need to store this as the speed
  62    * will already have changed once we get notified
  63    */
  64   double current_speed_     = 0;
  65   /**
  66    * How many flops are currently used by all the processes running on this
  67    * host?
  68    */
  69   double current_flops_     = 0;
  70   double computed_flops_    = 0;
  71   double idle_time_         = 0;
  72   double total_idle_time_   = 0; /* This gets never reset */
  73   double theor_max_flops_   = 0;
  74 };
  75
  76 simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
  77
  78 void HostLoad::add_activity(simgrid::kernel::activity::ExecImplPtr activity)
  79 {
  80   current_activities.insert({activity, activity_uninitialized_remaining_cost});
  81 }
  82
  83 void HostLoad::update()
  84 {
  85   double now = surf_get_clock();
  86
  87   // This loop updates the flops that the host executed for the ongoing computations
  88   for (auto& pair : current_activities) {
  89     auto& activity                         = pair.first;  // Just an alias
  90     auto& remaining_cost_after_last_update = pair.second; // Just an alias
  91
  92     if (activity->surf_action_->get_finish_time() != now && activity->state_ == e_smx_state_t::SIMIX_RUNNING) {
  93       if (remaining_cost_after_last_update == activity_uninitialized_remaining_cost) {
  94         remaining_cost_after_last_update = activity->surf_action_->get_cost();
  95       }
  96       double computed_flops_since_last_update = remaining_cost_after_last_update - /*remaining now*/activity->get_remaining();
  97       computed_flops_                        += computed_flops_since_last_update;
  98       remaining_cost_after_last_update        = activity->get_remaining();
  99     }
 100     else if (activity->state_ == e_smx_state_t::SIMIX_DONE) {
 101       computed_flops_ += remaining_cost_after_last_update;
 102       current_activities.erase(activity);
 103     }
 104   }
 105
 106   /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k @in {0, 1, ..., cores-1}
 107    * designates number of active cores; will be 0 if CPU is currently idle */
 108   current_flops_ = host_->pimpl_cpu->get_constraint()->get_usage();
 109
 110   if (current_flops_ == 0) {
 111     idle_time_ += (now - last_updated_);
 112     total_idle_time_ += (now - last_updated_);
 113     XBT_DEBUG("[%s]: Currently idle -> Added %f seconds to idle time (totaling %fs)", host_->get_cname(), (now - last_updated_), idle_time_);
 114   }
 115
 116   theor_max_flops_ += current_speed_ * host_->get_core_count() * (now - last_updated_);
 117   current_speed_ = host_->get_speed();
 118   last_updated_  = now;
 119 }
 120
 121 /**
 122  * WARNING: This function does not guarantee that you have the real load at any time imagine all actions on your CPU
 123  * terminate at time t. Your load is then 0. Then you query the load (still 0) and then another action starts (still at
 124  * time t!). This means that the load was never really 0 (because the time didn't advance) but it will still be reported
 125  * as 0.
 126  *
 127  * So, use at your own risk.
 128  */
 129 double HostLoad::get_current_load()
 130 {
 131   // We don't need to call update() here because it is called every time an action terminates or starts
 132   // FIXME: Can this happen at the same time? stop -> call to getCurrentLoad, load = 0 -> next action starts?
 133   return current_flops_ / static_cast<double>(host_->get_speed() * host_->get_core_count());
 134 }
 135
 136 /*
 137  * Resets the counters
 138  */
 139 void HostLoad::reset()
 140 {
 141   last_updated_    = surf_get_clock();
 142   last_reset_      = surf_get_clock();
 143   idle_time_       = 0;
 144   computed_flops_  = 0;
 145   theor_max_flops_ = 0;
 146   current_flops_   = host_->pimpl_cpu->get_constraint()->get_usage();
 147   current_speed_   = host_->get_speed();
 148 }
 149 } // namespace plugin
 150 } // namespace simgrid
 151
 152 using simgrid::plugin::HostLoad;
 153
 154 /* **************************** events  callback *************************** */
 155 /* This callback is fired either when the host changes its state (on/off) or its speed
 156  * (because the user changed the pstate, or because of external trace events) */
 157 static void on_host_change(simgrid::s4u::Host& host)
 158 {
 159   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 160     return;
 161
 162   host.extension<HostLoad>()->update();
 163 }
 164
 165 /* This callback is called when an action (computation, idle, ...) terminates */
 166 static void on_action_state_change(simgrid::surf::CpuAction* action, simgrid::kernel::resource::Action::State /*previous*/)
 167 {
 168   for (simgrid::surf::Cpu* const& cpu : action->cpus()) {
 169     simgrid::s4u::Host* host = cpu->get_host();
 170
 171     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host)) // Ignore virtual machines
 172       return;
 173
 174     if (host != nullptr) {
 175       host->extension<HostLoad>()->update();
 176     }
 177   }
 178 }
 179
 180 /* **************************** Public interface *************************** */
 181
 182 /** @ingroup plugin_load
 183  * @brief Initializes the HostLoad plugin
 184  * @details The HostLoad plugin provides an API to get the current load of each host.
 185  */
 186 void sg_host_load_plugin_init()
 187 {
 188   if (HostLoad::EXTENSION_ID.valid())
 189     return;
 190
 191   HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
 192
 193   if (simgrid::s4u::Engine::is_initialized()) { // If not yet initialized, this would create a new instance
 194                                                 // which would cause seg faults...
 195     simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
 196     for (auto& host : e->get_all_hosts()) {
 197       host->extension_set(new HostLoad(host));
 198     }
 199   }
 200
 201   /* When attaching a callback into a signal, you can use a lambda as follows, or a regular function as done below */
 202
 203   simgrid::s4u::Host::on_creation.connect([](simgrid::s4u::Host& host) {
 204     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 205       return;
 206     host.extension_set(new HostLoad(&host));
 207   });
 208
 209   simgrid::kernel::activity::ExecImpl::on_creation.connect([](simgrid::kernel::activity::ExecImplPtr activity){
 210     if (activity->host_ != nullptr) { // We only run on one host
 211       simgrid::s4u::Host* host = activity->host_;
 212       if (dynamic_cast<simgrid::s4u::VirtualMachine*>(activity->host_))
 213         host = dynamic_cast<simgrid::s4u::VirtualMachine*>(activity->host_)->get_pm();
 214
 215       host->extension<HostLoad>()->add_activity(activity);
 216       host->extension<HostLoad>()->update(); // If the system was idle until now, we need to update *before*
 217                                              // this computation starts running so we can keep track of the
 218                                              // idle time. (Communication operations don't trigger this hook!)
 219     }
 220     else { // This runs on multiple hosts
 221       XBT_DEBUG("HostLoad plugin currently does not support executions on several hosts");
 222     }
 223   });
 224   simgrid::kernel::activity::ExecImpl::on_completion.connect([](simgrid::kernel::activity::ExecImplPtr activity){
 225     if (activity->host_ != nullptr) { // We only run on one host
 226       simgrid::s4u::Host* host = activity->host_;
 227       if (dynamic_cast<simgrid::s4u::VirtualMachine*>(activity->host_))
 228         host = dynamic_cast<simgrid::s4u::VirtualMachine*>(activity->host_)->get_pm();
 229
 230       host->extension<HostLoad>()->update();
 231     }
 232     else { // This runs on multiple hosts
 233       XBT_DEBUG("HostLoad plugin currently does not support executions on several hosts");
 234     }
 235   });
 236   simgrid::s4u::Host::on_state_change.connect(&on_host_change);
 237   simgrid::s4u::Host::on_speed_change.connect(&on_host_change);
 238 }
 239
 240 /** @brief Returns the current load of the host passed as argument
 241  *
 242  *  See also @ref plugin_load
 243  */
 244 double sg_host_get_current_load(sg_host_t host)
 245 {
 246   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 247              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 248
 249   return host->extension<HostLoad>()->get_current_load();
 250 }
 251
 252 /** @brief Returns the current load of the host passed as argument
 253  *
 254  *  See also @ref plugin_load
 255  */
 256 double sg_host_get_avg_load(sg_host_t host)
 257 {
 258   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 259              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 260
 261   return host->extension<HostLoad>()->get_average_load();
 262 }
 263
 264 /** @brief Returns the time this host was idle since the last reset
 265  *
 266  *  See also @ref plugin_load
 267  */
 268 double sg_host_get_idle_time(sg_host_t host)
 269 {
 270   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 271              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 272
 273   return host->extension<HostLoad>()->get_idle_time();
 274 }
 275
 276 double sg_host_get_total_idle_time(sg_host_t host)
 277 {
 278   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 279              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 280
 281   return host->extension<HostLoad>()->get_total_idle_time();
 282 }
 283
 284 double sg_host_get_computed_flops(sg_host_t host)
 285 {
 286   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 287              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 288
 289   return host->extension<HostLoad>()->get_computed_flops();
 290 }
 291
 292 void sg_host_load_reset(sg_host_t host)
 293 {
 294   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 295              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 296
 297   host->extension<HostLoad>()->reset();
 298 }