1 /* Copyright (c) 2017-2021. 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/host.h"
7 #include "simgrid/plugins/load.h"
8 #include "simgrid/s4u/Link.hpp"
9 #include "src/surf/network_interface.hpp"
10 #include "src/surf/surf_interface.hpp"
11 #include "surf/surf.hpp"
15 SIMGRID_REGISTER_PLUGIN(link_load, "Link cumulated load.", &sg_link_load_plugin_init)
17 /** @defgroup plugin_link_load Plugin Link Cumulated Load
19 This is the link cumulated load plugin.
20 It enables to monitor how links are used over time by cumulating the amount of bytes that go through the link.
23 - Call sg_link_load_plugin_init() between the SimGrid engine initialization and the platform loading.
24 - Track the links you want to monitor with sg_link_load_track() — you can untrack them later with
25 sg_link_load_untrack().
26 - Query the cumulated data about your link via these functions:
27 - sg_link_get_cum_load() to get the total load (in bytes) that went though the link since last reset.
28 - sg_link_get_avg_load() to get the average load (in bytes) that went though the link since last reset.
29 - sg_link_get_min_instantaneous_load() to get the peak minimum load (in bytes per second) observed on the link since
31 - sg_link_get_max_instantaneous_load() to get the peak maximum load (in bytes per second) observer on the link since
33 - Reset the counters on any tracked link via sg_link_load_reset().
36 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_load, surf, "Logging specific to the SURF LinkLoad plugin");
42 s4u::Link* link_{}; /*< The link onto which this data is attached*/
43 bool is_tracked_{false}; /*<Whether the link is tracked or not*/
45 double cumulated_bytes_{}; /*< Cumulated load since last reset*/
46 double min_bytes_per_second_{}; /*< Minimum instantaneous load observed since last reset*/
47 double max_bytes_per_second_{}; /*< Maximum instantaneous load observed since last reset*/
48 double last_reset_{}; /*< Timestamp of the last reset (init timestamp by default)*/
49 double last_updated_{}; /*< Timestamp of the last energy update event*/
52 static xbt::Extension<s4u::Link, LinkLoad> EXTENSION_ID;
54 explicit LinkLoad(s4u::Link* ptr);
60 double get_average_bytes();
63 bool is_tracked() const { return is_tracked_; }
64 double get_cumulated_bytes();
65 double get_min_bytes_per_second();
66 double get_max_bytes_per_second();
69 xbt::Extension<s4u::Link, LinkLoad> LinkLoad::EXTENSION_ID;
71 LinkLoad::LinkLoad(s4u::Link* ptr) : link_(ptr), is_tracked_(false)
73 XBT_DEBUG("Instantiating a LinkLoad for link '%s'", link_->get_cname());
76 void LinkLoad::track()
78 xbt_assert(not is_tracked_, "Trying to track load of link '%s' while it is already tracked, aborting.",
80 XBT_DEBUG("Tracking load of link '%s'", link_->get_cname());
86 void LinkLoad::untrack()
88 xbt_assert(is_tracked_, "Trying to untrack load of link '%s' while it is not tracked, aborting.", link_->get_cname());
89 XBT_DEBUG("Untracking load of link '%s'", link_->get_cname());
94 void LinkLoad::reset()
96 XBT_DEBUG("Resetting load of link '%s'", link_->get_cname());
98 cumulated_bytes_ = 0.0;
99 min_bytes_per_second_ = std::numeric_limits<double>::max();
100 max_bytes_per_second_ = std::numeric_limits<double>::lowest();
101 XBT_DEBUG("min_bytes_per_second_ = %g", min_bytes_per_second_);
102 XBT_DEBUG("max_bytes_per_second_ = %g", max_bytes_per_second_);
103 last_reset_ = surf_get_clock();
104 last_updated_ = last_reset_;
107 void LinkLoad::update()
109 XBT_DEBUG("Updating load of link '%s'", link_->get_cname());
110 xbt_assert(is_tracked_,
111 "Trying to update load of link '%s' while it is NOT tracked, aborting."
112 " Please track your link with sg_link_load_track before trying to access any of its load metrics.",
115 double current_instantaneous_bytes_per_second = link_->get_usage();
116 double now = surf_get_clock();
118 // Update minimum/maximum observed values if needed
119 min_bytes_per_second_ = std::min(min_bytes_per_second_, current_instantaneous_bytes_per_second);
120 max_bytes_per_second_ = std::max(max_bytes_per_second_, current_instantaneous_bytes_per_second);
122 // Update cumulated load
123 double duration_since_last_update = now - last_updated_;
124 double bytes_since_last_update = duration_since_last_update * current_instantaneous_bytes_per_second;
125 XBT_DEBUG("Cumulated %g bytes since last update (duration of %g seconds)", bytes_since_last_update,
126 duration_since_last_update);
127 xbt_assert(bytes_since_last_update >= 0, "LinkLoad plugin inconsistency: negative amount of bytes is accumulated.");
129 cumulated_bytes_ += bytes_since_last_update;
133 double LinkLoad::get_cumulated_bytes()
136 return cumulated_bytes_;
138 double LinkLoad::get_min_bytes_per_second()
141 return min_bytes_per_second_;
143 double LinkLoad::get_max_bytes_per_second()
146 return max_bytes_per_second_;
149 double LinkLoad::get_average_bytes()
153 double now = surf_get_clock();
154 if (now > last_reset_)
155 return cumulated_bytes_ / (now - last_reset_);
160 } // namespace plugin
161 } // namespace simgrid
163 using simgrid::plugin::LinkLoad;
165 /* **************************** events callback *************************** */
166 static void on_communicate(const simgrid::kernel::resource::NetworkAction& action)
168 XBT_DEBUG("on_communicate is called");
169 for (auto* link : action.get_links()) {
170 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
173 auto link_load = link->get_iface()->extension<LinkLoad>();
174 if (link_load->is_tracked()) {
180 /* **************************** Public interface *************************** */
183 * @ingroup plugin_link_load
184 * @brief Initialize the link cumulated load plugin.
185 * @pre The energy plugin should NOT be initialized.
187 void sg_link_load_plugin_init()
189 xbt_assert(sg_host_count() == 0, "Please call sg_link_load_plugin_init() BEFORE initializing the platform.");
190 xbt_assert(not LinkLoad::EXTENSION_ID.valid(), "Double call to sg_link_load_plugin_init. Aborting.");
191 LinkLoad::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkLoad>();
193 // Attach new LinkLoad links created in the future.
194 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
195 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
196 XBT_DEBUG("Wired link '%s' created. Attaching a LinkLoad to it.", link.get_cname());
197 link.extension_set(new LinkLoad(&link));
199 XBT_DEBUG("Wireless link '%s' created. NOT attaching any LinkLoad to it.", link.get_cname());
203 // Call this plugin on some of the links' events.
204 simgrid::s4u::Link::on_communicate.connect(&on_communicate);
205 simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link const& link) {
206 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
207 auto link_load = link.extension<LinkLoad>();
208 if (link_load->is_tracked())
212 simgrid::s4u::Link::on_communication_state_change.connect(
213 [](simgrid::kernel::resource::NetworkAction const& action,
214 simgrid::kernel::resource::Action::State /* previous */) {
215 for (auto const* link : action.get_links()) {
216 if (link != nullptr && link->get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
217 auto link_load = link->get_iface()->extension<LinkLoad>();
218 if (link_load->is_tracked())
226 * @ingroup plugin_link_load
227 * @brief Start the tracking of a link.
228 * @details This is required so the link cumulated load can be obtained later on.
229 * @pre The energy plugin should be initialized (cf. sg_link_load_plugin_init()).
230 * @pre The link should be in "untracked" state. In other words, do not call this function twice on the same link
231 * without a sg_link_load_untrack() call between them.
233 * @param link The link to track.
235 void sg_link_load_track(const_sg_link_t link)
237 xbt_assert(LinkLoad::EXTENSION_ID.valid(),
238 "Please call sg_link_load_plugin_init before sg_link_load_track. Aborting.");
239 link->extension<LinkLoad>()->track();
243 * @ingroup plugin_link_load
244 * @brief Stop the tracking of a link.
245 * @details Once the tracking is stopped, the cumulated load of the link can no longer be obtained until
246 * sg_link_load_track() is called again on this link.
247 * @pre The energy plugin should be initialized (cf. sg_link_load_plugin_init()).
248 * @pre The link should be in "tracked" state. In other words, do not call this function twice on the same link without
249 * a sg_link_load_track() call between them.
251 * @param link The link to untrack.
253 void sg_link_load_untrack(const_sg_link_t link)
255 xbt_assert(LinkLoad::EXTENSION_ID.valid(),
256 "Please call sg_link_load_plugin_init before sg_link_load_untrack. Aborting.");
257 link->extension<LinkLoad>()->untrack();
261 * @ingroup plugin_link_load
262 * @brief Resets the cumulated load counters of a link.
263 * @pre The energy plugin should be initialized (cf. sg_link_load_plugin_init()).
264 * @pre The link should be in "tracked" state (cf. sg_link_load_track()).
266 * @param link The link whose counters should be reset.
268 void sg_link_load_reset(const_sg_link_t link)
270 xbt_assert(LinkLoad::EXTENSION_ID.valid(),
271 "Please call sg_link_load_plugin_init before sg_link_load_reset. Aborting.");
272 link->extension<LinkLoad>()->reset();
276 * @ingroup plugin_link_load
277 * @brief Get the cumulated load of a link (since the last call to sg_link_load_reset()).
278 * @pre The energy plugin should be initialized (cf. sg_link_load_plugin_init()).
279 * @pre The link should be in "tracked" state (cf. sg_link_load_track()).
281 * @param link The link whose cumulated load is requested.
282 * @return The load (in bytes) that passed through the given link since the last call to sg_link_load_reset.
284 double sg_link_get_cum_load(const_sg_link_t link)
286 xbt_assert(LinkLoad::EXTENSION_ID.valid(),
287 "Please call sg_link_load_plugin_init before sg_link_get_cum_load. Aborting.");
288 return link->extension<LinkLoad>()->get_cumulated_bytes();
292 * @ingroup plugin_link_load
293 * @brief Get the average load of a link (since the last call to sg_link_load_reset()).
294 * @pre The energy plugin should be initialized (cf. sg_link_load_plugin_init()).
295 * @pre The link should be in "tracked" state (cf. sg_link_load_track()).
297 * @param link The link whose average load is requested.
298 * @return The average load (in bytes) that passed through the given link since the last call to sg_link_load_reset.
300 double sg_link_get_avg_load(const_sg_link_t link)
302 xbt_assert(LinkLoad::EXTENSION_ID.valid(),
303 "Please call sg_link_load_plugin_init before sg_link_get_avg_load. Aborting.");
304 return link->extension<LinkLoad>()->get_average_bytes();
308 * @ingroup plugin_link_load
309 * @brief Get the minimum instantaneous load of a link (since the last call to sg_link_load_reset()).
310 * @pre The energy plugin should be initialized (cf. sg_link_load_plugin_init()).
311 * @pre The link should be in "tracked" state (cf. sg_link_load_track()).
313 * @param link The link whose average load is requested.
314 * @return The minimum load instantaneous load (in bytes per second) that passed through the given link since the last
315 call to sg_link_load_reset.
317 double sg_link_get_min_instantaneous_load(const_sg_link_t link)
319 xbt_assert(LinkLoad::EXTENSION_ID.valid(),
320 "Please call sg_link_load_plugin_init before sg_link_get_min_load. Aborting.");
321 return link->extension<LinkLoad>()->get_min_bytes_per_second();
325 * @ingroup plugin_link_load
326 * @brief Get the maximum instantaneous load of a link (since the last call to sg_link_load_reset()).
327 * @pre The energy plugin should be initialized (cf. sg_link_load_plugin_init()).
328 * @pre The link should be in "tracked" state (cf. sg_link_load_track()).
330 * @param link The link whose average load is requested.
331 * @return The maximum load instantaneous load (in bytes per second) that passed through the given link since the last
332 call to sg_link_load_reset.
334 double sg_link_get_max_instantaneous_load(const_sg_link_t link)
336 xbt_assert(LinkLoad::EXTENSION_ID.valid(),
337 "Please call sg_link_load_plugin_init before sg_link_get_max_load. Aborting.");
338 return link->extension<LinkLoad>()->get_max_bytes_per_second();