src/surf/plugins/host_load.cpp

   1 /* Copyright (c) 2010, 2012-2016. 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 <boost/algorithm/string/classification.hpp>
  12 #include <boost/algorithm/string/split.hpp>
  13 #include <simgrid/s4u/engine.hpp>
  14 #include <string>
  15 #include <utility>
  16 #include <vector>
  17
  18 /** @addtogroup SURF_plugin_load
  19
  20 This plugin makes it very simple for users to obtain the current load for each host.
  21
  22 */
  23
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the SURF HostLoad plugin");
  25
  26 namespace simgrid {
  27 namespace plugin {
  28
  29 class HostLoad {
  30 public:
  31   static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
  32
  33   explicit HostLoad(simgrid::s4u::Host* ptr);
  34   ~HostLoad();
  35
  36   double getCurrentLoad();
  37   double getComputedFlops();
  38   void update();
  39   void reset();
  40
  41 private:
  42   simgrid::s4u::Host* host = nullptr;
  43   double last_updated      = 0;
  44   double current_flops     = 0;
  45   double computed_flops    = 0;
  46 };
  47
  48 simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
  49
  50 HostLoad::HostLoad(simgrid::s4u::Host* ptr)
  51     : host(ptr), last_updated(surf_get_clock()), current_flops(lmm_constraint_get_usage(host->pimpl_cpu->constraint()))
  52 {
  53 }
  54
  55 HostLoad::~HostLoad() = default;
  56
  57 void HostLoad::update()
  58 {
  59   double now = surf_get_clock();
  60   if (last_updated < now) {
  61     /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k \in {0, 1, ..., cores}
  62      * number of active cores */
  63     current_flops = lmm_constraint_get_usage(host->pimpl_cpu->constraint());
  64
  65     /* flops == pstate_speed * cores_being_currently_used */
  66     computed_flops += (now - last_updated) * current_flops;
  67     last_updated = now;
  68   }
  69 }
  70
  71 double HostLoad::getCurrentLoad()
  72 {
  73   return current_flops / (host->speed() * host->coreCount());
  74 }
  75
  76 double HostLoad::getComputedFlops()
  77 {
  78   update();
  79
  80   return computed_flops;
  81 }
  82
  83 /*
  84  * Resets the counters
  85  */
  86 void HostLoad::reset()
  87 {
  88   last_updated   = surf_get_clock();
  89   computed_flops = 0;
  90 }
  91 }
  92 }
  93
  94 using simgrid::plugin::HostLoad;
  95
  96 /* **************************** events  callback *************************** */
  97 static void on_host_added(simgrid::s4u::Host& host)
  98 {
  99   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 100     return;
 101   host.extension_set(new HostLoad(&host));
 102 }
 103
 104 /* This callback is fired either when the host changes its state (on/off) or its speed
 105  * (because the user changed the pstate, or because of external trace events) */
 106 static void onHostChange(simgrid::s4u::Host& host)
 107 {
 108   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 109     return;
 110
 111   HostLoad* host_load = host.extension<HostLoad>();
 112   host_load->update();
 113 }
 114
 115 /* This callback is called when an action (computation, idle, ...) terminates */
 116 static void onActionStateChange(simgrid::surf::CpuAction* action, simgrid::surf::Action::State previous)
 117 {
 118   for (simgrid::surf::Cpu* cpu : action->cpus()) {
 119     simgrid::s4u::Host* host = cpu->getHost();
 120
 121     if (host == nullptr)
 122       continue;
 123
 124     // Get the host_load extension for the relevant host
 125     HostLoad* host_load = host->extension<HostLoad>();
 126     host_load->update();
 127   }
 128 }
 129
 130 /* **************************** Public interface *************************** */
 131 SG_BEGIN_DECL()
 132
 133 /** \ingroup SURF_plugin_load
 134  * \brief Initializes the HostLoad plugin
 135  * \details The HostLoad plugin provides an API to get the current load of each host.
 136  */
 137 void sg_host_load_plugin_init()
 138 {
 139   if (HostLoad::EXTENSION_ID.valid())
 140     return;
 141
 142   HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
 143
 144   simgrid::s4u::Host::onCreation.connect(&on_host_added);
 145   simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
 146   simgrid::s4u::Host::onStateChange.connect(&onHostChange);
 147   simgrid::s4u::Host::onSpeedChange.connect(&onHostChange);
 148 }
 149
 150 /** @brief Returns the current load of the host passed as argument
 151  *
 152  *  See also @ref SURF_plugin_load
 153  */
 154 double sg_host_get_current_load(sg_host_t host)
 155 {
 156   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 157              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 158
 159   return host->extension<HostLoad>()->getCurrentLoad();
 160 }
 161
 162 double sg_host_get_computed_flops(sg_host_t host)
 163 {
 164   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 165              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 166
 167   return host->extension<HostLoad>()->getComputedFlops();
 168 }
 169
 170 void sg_host_load_reset(sg_host_t host)
 171 {
 172   xbt_assert(HostLoad::EXTENSION_ID.valid(),
 173              "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
 174
 175   host->extension<HostLoad>()->reset();
 176 }
 177
 178 SG_END_DECL()