1 /* Copyright (c) 2010-2017. 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 "simgrid/s4u/Engine.hpp"
13 #include <boost/algorithm/string/classification.hpp>
14 #include <boost/algorithm/string/split.hpp>
19 /** @addtogroup plugin_load
21 This plugin makes it very simple for users to obtain the current load for each host.
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the HostLoad plugin");
32 static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
34 explicit HostLoad(simgrid::s4u::Host* ptr);
37 double getCurrentLoad();
38 double getComputedFlops();
39 double getAverageLoad();
44 simgrid::s4u::Host* host = nullptr;
45 double last_updated = 0;
46 double last_reset = 0;
47 double current_flops = 0;
48 double computed_flops = 0;
51 simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
53 HostLoad::HostLoad(simgrid::s4u::Host* ptr)
55 , last_updated(surf_get_clock())
56 , last_reset(surf_get_clock())
57 , current_flops(host->pimpl_cpu->constraint()->get_usage())
61 HostLoad::~HostLoad() = default;
63 void HostLoad::update()
65 double now = surf_get_clock();
66 if (last_updated < now) {
67 /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k \in {0, 1, ..., cores}
68 * number of active cores */
69 current_flops = host->pimpl_cpu->constraint()->get_usage();
71 /* flops == pstate_speed * cores_being_currently_used */
72 computed_flops += (now - last_updated) * current_flops;
77 double HostLoad::getCurrentLoad()
79 return current_flops / static_cast<double>(host->getSpeed() * host->getCoreCount());
82 double HostLoad::getAverageLoad()
84 return getComputedFlops() / (host->getSpeed() * host->getCoreCount() * (surf_get_clock() - last_reset));
87 double HostLoad::getComputedFlops()
91 return computed_flops;
97 void HostLoad::reset()
99 last_updated = surf_get_clock();
100 last_reset = surf_get_clock();
106 using simgrid::plugin::HostLoad;
108 /* **************************** events callback *************************** */
109 /* This callback is fired either when the host changes its state (on/off) or its speed
110 * (because the user changed the pstate, or because of external trace events) */
111 static void onHostChange(simgrid::s4u::Host& host)
113 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
116 host.extension<HostLoad>()->update();
119 /* This callback is called when an action (computation, idle, ...) terminates */
120 static void onActionStateChange(simgrid::surf::CpuAction* action, simgrid::surf::Action::State /*previous*/)
122 for (simgrid::surf::Cpu* const& cpu : action->cpus()) {
123 simgrid::s4u::Host* host = cpu->getHost();
125 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host)) // Ignore virtual machines
128 if (host != nullptr) {
129 host->extension<HostLoad>()->update();
134 /* **************************** Public interface *************************** */
137 /** \ingroup plugin_load
138 * \brief Initializes the HostLoad plugin
139 * \details The HostLoad plugin provides an API to get the current load of each host.
141 void sg_host_load_plugin_init()
143 if (HostLoad::EXTENSION_ID.valid())
146 HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
148 /* When attaching a callback into a signal, you can use a lambda as follows, or a regular function as done below */
150 simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
151 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
153 host.extension_set(new HostLoad(&host));
156 simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
157 simgrid::s4u::Host::onStateChange.connect(&onHostChange);
158 simgrid::s4u::Host::onSpeedChange.connect(&onHostChange);
161 /** @brief Returns the current load of the host passed as argument
163 * See also @ref plugin_load
165 double sg_host_get_current_load(sg_host_t host)
167 xbt_assert(HostLoad::EXTENSION_ID.valid(),
168 "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
170 return host->extension<HostLoad>()->getCurrentLoad();
173 double sg_host_get_computed_flops(sg_host_t host)
175 xbt_assert(HostLoad::EXTENSION_ID.valid(),
176 "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
178 return host->extension<HostLoad>()->getComputedFlops();
181 void sg_host_load_reset(sg_host_t host)
183 xbt_assert(HostLoad::EXTENSION_ID.valid(),
184 "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization.");
186 host->extension<HostLoad>()->reset();