X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c6bbeb1829c36ff45b43ab25f9d8d3f53f554d98..b372d23d3d8818b4547ef207f43b45709298a002:/src/plugins/host_load.cpp diff --git a/src/plugins/host_load.cpp b/src/plugins/host_load.cpp index cf0141a8c6..c8b03e53cb 100644 --- a/src/plugins/host_load.cpp +++ b/src/plugins/host_load.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2010-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2010-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -12,19 +12,17 @@ // Makes sure that this plugin can be activated from the command line with ``--cfg=plugin:host_load`` SIMGRID_REGISTER_PLUGIN(host_load, "Cpu load", &sg_host_load_plugin_init) -/** @defgroup plugin_host_load +/** @defgroup plugin_host_load Simple plugin that monitors the current load for each host. @beginrst - -Simple plugin that monitors the current load for each host. - In addition, this constitutes a good introductory example on how to write a plugin. It attaches an extension to each host to store some data, and places callbacks in the following signals: - :cpp:member:`simgrid::s4u::Host::on_creation`: Attach a new extension to the newly created host. - :cpp:member:`simgrid::s4u::Exec::on_start`: Make note that a new execution started, increasing the load. - :cpp:member:`simgrid::s4u::Exec::on_completion`: Make note that an execution completed, decreasing the load. - - :cpp:member:`simgrid::s4u::Host::on_state_change`: Do what is appropriate when the host gets suspended, turned off or similar. + - :cpp:member:`simgrid::s4u::Host::on_state_change`: Do what is appropriate when the host gets suspended, turned off + or similar. - :cpp:member:`simgrid::s4u::Host::on_speed_change`: Do what is appropriate when the DVFS is modified. Note that extensions are automatically destroyed when the host gets destroyed. @@ -70,7 +68,7 @@ public: explicit HostLoad(simgrid::s4u::Host& ptr) = delete; explicit HostLoad(simgrid::s4u::Host&& ptr) = delete; - double get_current_load(); + double get_current_load() const; /** Get the the average load since last reset(), as a ratio * * That's the ratio (amount of flops that were actually computed) / (amount of flops that could have been computed at full speed) @@ -170,7 +168,7 @@ void HostLoad::update() * But still, if you call this function between the two events (in the simulator course), it * returns 0 although there is no time (in the simulated time) where this value is valid. */ -double HostLoad::get_current_load() +double HostLoad::get_current_load() const { // We don't need to call update() here because it is called every time an action terminates or starts return current_flops_ / (host_->get_speed() * host_->get_core_count()); @@ -220,7 +218,7 @@ void sg_host_load_plugin_init() // If SimGrid is already initialized, we need to attach an extension to each existing host if (simgrid::s4u::Engine::is_initialized()) { - simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance(); + const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance(); for (auto& host : e->get_all_hosts()) { host->extension_set(new HostLoad(host)); } @@ -233,10 +231,10 @@ void sg_host_load_plugin_init() host.extension_set(new HostLoad(&host)); }); - simgrid::s4u::Exec::on_start.connect([](simgrid::s4u::Actor const&, simgrid::s4u::Exec const& activity) { + simgrid::s4u::Exec::on_start.connect([](simgrid::s4u::Exec const& activity) { if (activity.get_host_number() == 1) { // We only run on one host simgrid::s4u::Host* host = activity.get_host(); - simgrid::s4u::VirtualMachine* vm = dynamic_cast(host); + const simgrid::s4u::VirtualMachine* vm = dynamic_cast(host); if (vm != nullptr) host = vm->get_pm(); xbt_assert(host != nullptr); @@ -249,10 +247,10 @@ void sg_host_load_plugin_init() XBT_WARN("HostLoad plugin currently does not support executions on several hosts"); } }); - simgrid::s4u::Exec::on_completion.connect([](simgrid::s4u::Actor const&, simgrid::s4u::Exec const& activity) { + simgrid::s4u::Exec::on_completion.connect([](simgrid::s4u::Exec const& activity) { if (activity.get_host_number() == 1) { // We only run on one host simgrid::s4u::Host* host = activity.get_host(); - simgrid::s4u::VirtualMachine* vm = dynamic_cast(host); + const simgrid::s4u::VirtualMachine* vm = dynamic_cast(host); if (vm != nullptr) host = vm->get_pm(); xbt_assert(host != nullptr); @@ -269,7 +267,7 @@ void sg_host_load_plugin_init() /** @brief Returns the current load of that host, as a ratio = achieved_flops / (core_current_speed * core_amount) * @ingroup plugin_host_load */ -double sg_host_get_current_load(sg_host_t host) +double sg_host_get_current_load(const_sg_host_t host) { xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); @@ -279,7 +277,7 @@ double sg_host_get_current_load(sg_host_t host) /** @brief Returns the current load of that host * @ingroup plugin_host_load */ -double sg_host_get_avg_load(sg_host_t host) +double sg_host_get_avg_load(const_sg_host_t host) { xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); @@ -289,7 +287,7 @@ double sg_host_get_avg_load(sg_host_t host) /** @brief Returns the time this host was idle since the last reset * @ingroup plugin_host_load */ -double sg_host_get_idle_time(sg_host_t host) +double sg_host_get_idle_time(const_sg_host_t host) { xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); @@ -299,7 +297,7 @@ double sg_host_get_idle_time(sg_host_t host) /** @brief Returns the time this host was idle since the beginning of the simulation * @ingroup plugin_host_load */ -double sg_host_get_total_idle_time(sg_host_t host) +double sg_host_get_total_idle_time(const_sg_host_t host) { xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); @@ -309,7 +307,7 @@ double sg_host_get_total_idle_time(sg_host_t host) /** @brief Returns the amount of flops computed by that host since the last reset * @ingroup plugin_host_load */ -double sg_host_get_computed_flops(sg_host_t host) +double sg_host_get_computed_flops(const_sg_host_t host) { xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); @@ -319,7 +317,7 @@ double sg_host_get_computed_flops(sg_host_t host) /** @brief Resets the idle time and flops amount of that host * @ingroup plugin_host_load */ -void sg_host_load_reset(sg_host_t host) +void sg_host_load_reset(const_sg_host_t host) { xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin.");