Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move all plugins to their new home directory
[simgrid.git] / src / surf / plugins / host_load.cpp
diff --git a/src/surf/plugins/host_load.cpp b/src/surf/plugins/host_load.cpp
deleted file mode 100644 (file)
index a728f25..0000000
+++ /dev/null
@@ -1,241 +0,0 @@
-/* Copyright (c) 2010-2018. 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. */
-
-#include "simgrid/plugins/load.h"
-#include "src/plugins/vm/VirtualMachineImpl.hpp"
-
-/** @addtogroup plugin_load
-
-This plugin makes it very simple for users to obtain the current load for each host.
-
-*/
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_load, surf, "Logging specific to the HostLoad plugin");
-
-namespace simgrid {
-namespace plugin {
-
-class HostLoad {
-public:
-  static simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> EXTENSION_ID;
-
-  explicit HostLoad(simgrid::s4u::Host* ptr);
-  ~HostLoad();
-
-  double getCurrentLoad();
-  double getComputedFlops();
-  double getAverageLoad();
-  double getIdleTime();
-  void update();
-  void reset();
-
-private:
-  simgrid::s4u::Host* host = nullptr;
-  double last_updated      = 0;
-  double last_reset        = 0;
-  double current_speed     = 0;
-  double current_flops     = 0;
-  double computed_flops    = 0;
-  double idle_time         = 0;
-  double theor_max_flops   = 0;
-  bool   was_prev_idle     = true; /* A host is idle at the beginning */
-};
-
-simgrid::xbt::Extension<simgrid::s4u::Host, HostLoad> HostLoad::EXTENSION_ID;
-
-HostLoad::HostLoad(simgrid::s4u::Host* ptr)
-    : host(ptr)
-    , last_updated(surf_get_clock())
-    , last_reset(surf_get_clock())
-    , current_speed(host->getSpeed())
-    , current_flops(host->pimpl_cpu->get_constraint()->get_usage())
-    , theor_max_flops(0)
-    , was_prev_idle(current_flops == 0)
-{
-}
-
-HostLoad::~HostLoad() = default;
-
-void HostLoad::update()
-{
-  double now = surf_get_clock();
-
-  /* Current flop per second computed by the cpu; current_flops = k * pstate_speed_in_flops, k \in {0, 1, ..., cores}
-   * number of active cores */
-  current_flops = host->pimpl_cpu->get_constraint()->get_usage();
-
-  /* flops == pstate_speed * cores_being_currently_used */
-  computed_flops += (now - last_updated) * current_flops;
-
-  if (was_prev_idle) {
-    idle_time += (now - last_updated);
-  }
-
-  theor_max_flops += current_speed * host->get_core_count() * (now - last_updated);
-  current_speed    = host->getSpeed();
-  last_updated     = now;
-  was_prev_idle    = (current_flops == 0);
-}
-
-/**
- * WARNING: This function does not guarantee that you have the real load at any time
- * imagine all actions on your CPU terminate at time t. Your load is then 0. Then
- * you query the load (still 0) and then another action starts (still at time t!).
- * This means that the load was never really 0 (because the time didn't advance) but
- * it will still be reported as 0.
- *
- * So, use at your own risk.
- */
-double HostLoad::getCurrentLoad()
-{
-  // We don't need to call update() here because it is called everytime an
-  // action terminates or starts
-  // FIXME: Can this happen at the same time? stop -> call to getCurrentLoad, load = 0 -> next action starts?
-  return current_flops / static_cast<double>(host->getSpeed() * host->get_core_count());
-}
-
-/**
- * Return idle time since last reset
- */
-double HostLoad::getIdleTime() {
-  return idle_time;
-}
-
-double HostLoad::getAverageLoad()
-{
-  if (theor_max_flops == 0) { // Avoid division by 0
-    return 0;
-  }
-
-  return computed_flops / theor_max_flops;
-}
-
-double HostLoad::getComputedFlops()
-{
-  return computed_flops;
-}
-
-/*
- * Resets the counters
- */
-void HostLoad::reset()
-{
-  last_updated    = surf_get_clock();
-  last_reset      = surf_get_clock();
-  idle_time       = 0;
-  computed_flops  = 0;
-  theor_max_flops = 0;
-  current_flops   = host->pimpl_cpu->get_constraint()->get_usage();
-  current_speed   = host->getSpeed();
-  was_prev_idle   = (current_flops == 0);
-}
-}
-}
-
-using simgrid::plugin::HostLoad;
-
-/* **************************** events  callback *************************** */
-/* This callback is fired either when the host changes its state (on/off) or its speed
- * (because the user changed the pstate, or because of external trace events) */
-static void onHostChange(simgrid::s4u::Host& host)
-{
-  if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
-    return;
-
-  host.extension<HostLoad>()->update();
-}
-
-/* This callback is called when an action (computation, idle, ...) terminates */
-static void onActionStateChange(simgrid::surf::CpuAction* action, simgrid::kernel::resource::Action::State /*previous*/)
-{
-  for (simgrid::surf::Cpu* const& cpu : action->cpus()) {
-    simgrid::s4u::Host* host = cpu->get_host();
-
-    if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host)) // Ignore virtual machines
-      return;
-
-    if (host != nullptr) {
-      host->extension<HostLoad>()->update();
-    }
-  }
-}
-
-/* **************************** Public interface *************************** */
-
-/** \ingroup plugin_load
- * \brief Initializes the HostLoad plugin
- * \details The HostLoad plugin provides an API to get the current load of each host.
- */
-void sg_host_load_plugin_init()
-{
-  if (HostLoad::EXTENSION_ID.valid())
-    return;
-
-  HostLoad::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostLoad>();
-
-  /* When attaching a callback into a signal, you can use a lambda as follows, or a regular function as done below */
-
-  simgrid::s4u::Host::on_creation.connect([](simgrid::s4u::Host& host) {
-    if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
-      return;
-    host.extension_set(new HostLoad(&host));
-  });
-
-  simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
-  simgrid::s4u::Host::on_state_change.connect(&onHostChange);
-  simgrid::s4u::Host::on_speed_change.connect(&onHostChange);
-}
-
-/** @brief Returns the current load of the host passed as argument
- *
- *  See also @ref plugin_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.");
-
-  return host->extension<HostLoad>()->getCurrentLoad();
-}
-
-/** @brief Returns the current load of the host passed as argument
- *
- *  See also @ref plugin_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.");
-
-  return host->extension<HostLoad>()->getAverageLoad();
-}
-
-/** @brief Returns the time this host was idle since the last reset
- *
- *  See also @ref plugin_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.");
-
-  return host->extension<HostLoad>()->getIdleTime();
-}
-
-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.");
-
-  return host->extension<HostLoad>()->getComputedFlops();
-}
-
-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.");
-
-  host->extension<HostLoad>()->reset();
-}