X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9e520c5a3497bcaad04415c221071ef9be69866d..b4ace96f8a501a6659817d9741aeb103cbcfd2c4:/src/plugins/host_load.cpp diff --git a/src/plugins/host_load.cpp b/src/plugins/host_load.cpp index 85828913ba..060577d454 100644 --- a/src/plugins/host_load.cpp +++ b/src/plugins/host_load.cpp @@ -9,12 +9,26 @@ #include "src/plugins/vm/VirtualMachineImpl.hpp" #include +// Makes sure that this plugin can be activated from the command line with ``--plugin=name`` SIMGRID_REGISTER_PLUGIN(host_load, "Cpu load", &sg_host_load_plugin_init) -/** @addtogroup plugin_load +/** @defgroup plugin_host_load -This plugin makes it very simple for users to obtain the current load for each host. + @rst +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_speed_change`: Do what is appropriate when the DVFS is modified. + + Note that extensions are automatically destroyed when the host gets destroyed. + @endrst */ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the HostLoad plugin"); @@ -24,6 +38,21 @@ namespace plugin { static const double activity_uninitialized_remaining_cost = -1; +/** This class stores the extra data needed by this plugin about a given host + * + * It is stored as an extension of s4u::Host. Such extensions are retrieved by type as follows: + * + * @verbatim + * simgrid::s4u::Host* this_host = ???; + * this_extension = host->extension(); + * @endverbatim + * + * If no extension of that type was ever attached to the inspected object, the ``extension()`` template returns + * nullptr. + * + * Please refer to the implementation of ``sg_host_load_plugin_init()`` to see the extension objects are attached to + * hosts at initialization time. + */ class HostLoad { public: static simgrid::xbt::Extension EXTENSION_ID; @@ -55,13 +84,13 @@ public: /** Return idle time over the whole simulation */ double get_total_idle_time() { update(); return total_idle_time_; } void update(); - void add_activity(simgrid::kernel::activity::ExecImplPtr activity); + void add_activity(simgrid::kernel::activity::ExecImpl* activity); void reset(); private: simgrid::s4u::Host* host_ = nullptr; /* Stores all currently ongoing activities (computations) on this machine */ - std::map current_activities; + std::map current_activities; double last_updated_ = 0; double last_reset_ = 0; /** @@ -76,13 +105,14 @@ private: double current_flops_ = 0; double computed_flops_ = 0; double idle_time_ = 0; - double total_idle_time_ = 0; /* This gets never reset */ + double total_idle_time_ = 0; /* This updated but never gets reset */ double theor_max_flops_ = 0; }; +// Create the static field that the extension mechanism needs simgrid::xbt::Extension HostLoad::EXTENSION_ID; -void HostLoad::add_activity(simgrid::kernel::activity::ExecImplPtr activity) +void HostLoad::add_activity(simgrid::kernel::activity::ExecImpl* activity) { current_activities.insert({activity, activity_uninitialized_remaining_cost}); } @@ -180,7 +210,7 @@ static void on_host_change(simgrid::s4u::Host const& host) /* **************************** Public interface *************************** */ /** @brief Initializes the HostLoad plugin - * @details The HostLoad plugin provides an API to get the current load of each host. + * @ingroup plugin_host_load */ void sg_host_load_plugin_init() { @@ -205,14 +235,14 @@ void sg_host_load_plugin_init() host.extension_set(new HostLoad(&host)); }); - simgrid::kernel::activity::ExecImpl::on_creation.connect([](simgrid::kernel::activity::ExecImpl& activity) { + simgrid::s4u::Exec::on_start.connect([](simgrid::s4u::Actor const&, 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); if (vm != nullptr) host = vm->get_pm(); xbt_assert(host != nullptr); - host->extension()->add_activity(&activity); + host->extension()->add_activity(static_cast(activity.get_impl())); host->extension()->update(); // If the system was idle until now, we need to update *before* // this computation starts running so we can keep track of the // idle time. (Communication operations don't trigger this hook!) @@ -221,7 +251,7 @@ void sg_host_load_plugin_init() XBT_WARN("HostLoad plugin currently does not support executions on several hosts"); } }); - simgrid::kernel::activity::ExecImpl::on_completion.connect([](simgrid::kernel::activity::ExecImpl const& activity) { + simgrid::s4u::Exec::on_completion.connect([](simgrid::s4u::Actor const&, 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); @@ -239,61 +269,61 @@ void sg_host_load_plugin_init() } /** @brief Returns the current load of that host, as a ratio = achieved_flops / (core_current_speed * core_amount) - * - * See simgrid::plugin::HostLoad::get_current_load() for the full documentation. + * @ingroup plugin_host_load */ double sg_host_get_current_load(sg_host_t host) { - xbt_assert(HostLoad::EXTENSION_ID.valid(), - "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization."); + xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); return host->extension()->get_current_load(); } -/** @brief Returns the current load of the host passed as argument - * - * See also @ref plugin_load +/** @brief Returns the current load of that host + * @ingroup plugin_host_load */ double sg_host_get_avg_load(sg_host_t host) { - xbt_assert(HostLoad::EXTENSION_ID.valid(), - "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization."); + xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); return host->extension()->get_average_load(); } /** @brief Returns the time this host was idle since the last reset - * - * See also @ref plugin_load + * @ingroup plugin_host_load */ double sg_host_get_idle_time(sg_host_t host) { - xbt_assert(HostLoad::EXTENSION_ID.valid(), - "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization."); + xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); return host->extension()->get_idle_time(); } +/** @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) { - xbt_assert(HostLoad::EXTENSION_ID.valid(), - "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization."); + xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); return host->extension()->get_total_idle_time(); } +/** @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) { - xbt_assert(HostLoad::EXTENSION_ID.valid(), - "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization."); + xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); return host->extension()->get_computed_flops(); } +/** @brief Resets the idle time and flops amount of that host + * @ingroup plugin_host_load + */ void sg_host_load_reset(sg_host_t host) { - xbt_assert(HostLoad::EXTENSION_ID.valid(), - "The Load plugin is not active. Please call sg_host_load_plugin_init() during initialization."); + xbt_assert(HostLoad::EXTENSION_ID.valid(), "Please sg_host_load_plugin_init() to initialize this plugin."); host->extension()->reset(); }