1 /* Copyright (c) 2010, 2012-2016. The SimGrid Team. All rights reserved. */
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. */
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"
11 #include <boost/algorithm/string/classification.hpp>
12 #include <boost/algorithm/string/split.hpp>
13 #include <simgrid/s4u/engine.hpp>
18 /** @addtogroup SURF_plugin_load
20 This plugin makes it very simple for users to obtain the current load for each host.
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the SURF HostLoad plugin");
31 static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
33 explicit HostLoad(simgrid::s4u::Host* ptr);
36 double getCurrentLoad();
37 double getComputedFlops();
38 double getAverageLoad();
43 simgrid::s4u::Host* host = nullptr;
44 double last_updated = 0;
45 double last_reset = 0;
46 double current_flops = 0;
47 double computed_flops = 0;
50 simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
52 HostLoad::HostLoad(simgrid::s4u::Host* ptr)
54 , last_updated(surf_get_clock())
55 , last_reset(surf_get_clock())
56 , current_flops(lmm_constraint_get_usage(host->pimpl_cpu->constraint()))
60 HostLoad::~HostLoad() = default;
62 void HostLoad::update()
64 double now = surf_get_clock();
65 if (last_updated < now) {
66 /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k \in {0, 1, ..., cores}
67 * number of active cores */
68 current_flops = lmm_constraint_get_usage(host->pimpl_cpu->constraint());
70 /* flops == pstate_speed * cores_being_currently_used */
71 computed_flops += (now - last_updated) * current_flops;
76 double HostLoad::getCurrentLoad()
78 return current_flops / (host->speed() * host->coreCount());
81 double HostLoad::getAverageLoad()
83 return getComputedFlops() / (host->speed() * host->coreCount() * (surf_get_clock() - last_reset));
86 double HostLoad::getComputedFlops()
90 return computed_flops;
96 void HostLoad::reset()
98 last_updated = surf_get_clock();
99 last_reset = surf_get_clock();
105 using simgrid::plugin::HostLoad;
107 /* **************************** events callback *************************** */
108 static void on_host_added(simgrid::s4u::Host& host)
110 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
112 host.extension_set(new HostLoad(&host));
115 /* This callback is fired either when the host changes its state (on/off) or its speed
116 * (because the user changed the pstate, or because of external trace events) */
117 static void onHostChange(simgrid::s4u::Host& host)
119 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
122 HostLoad* host_load = host.extension<HostLoad>();
126 /* This callback is called when an action (computation, idle, ...) terminates */
127 static void onActionStateChange(simgrid::surf::CpuAction* action, simgrid::surf::Action::State previous)
129 for (simgrid::surf::Cpu* cpu : action->cpus()) {
130 simgrid::s4u::Host* host = cpu->getHost();
132 if (host != nullptr) {
133 // Get the host_load extension for the relevant host
134 HostLoad* host_load = host->extension<HostLoad>();
140 /* **************************** Public interface *************************** */
143 /** \ingroup SURF_plugin_load
144 * \brief Initializes the HostLoad plugin
145 * \details The HostLoad plugin provides an API to get the current load of each host.
147 void sg_host_load_plugin_init()
149 if (HostLoad::EXTENSION_ID.valid())
152 HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
154 simgrid::s4u::Host::onCreation.connect(&on_host_added);
155 simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
156 simgrid::s4u::Host::onStateChange.connect(&onHostChange);
157 simgrid::s4u::Host::onSpeedChange.connect(&onHostChange);
160 /** @brief Returns the current load of the host passed as argument
162 * See also @ref SURF_plugin_load
164 double sg_host_get_current_load(sg_host_t host)
166 xbt_assert(HostLoad::EXTENSION_ID.valid(),
167 "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
169 return host->extension<HostLoad>()->getCurrentLoad();
172 double sg_host_get_computed_flops(sg_host_t host)
174 xbt_assert(HostLoad::EXTENSION_ID.valid(),
175 "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
177 return host->extension<HostLoad>()->getComputedFlops();
180 void sg_host_load_reset(sg_host_t host)
182 xbt_assert(HostLoad::EXTENSION_ID.valid(),
183 "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
185 host->extension<HostLoad>()->reset();