Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move collective algorithms to separate folders
[simgrid.git] / src / s4u / s4u_host.cpp
index c327312..e3c3635 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2006-2014. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2017. 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 <functional>
 #include <stdexcept>
 
-#include <unordered_map>
+#include <map>
 
-#include <simgrid/simix.hpp>
-
-#include "xbt/log.h"
+#include "simgrid/s4u/engine.hpp"
+#include "simgrid/s4u/host.hpp"
+#include "simgrid/s4u/storage.hpp"
+#include "simgrid/simix.hpp"
+#include "src/kernel/routing/NetPoint.hpp"
 #include "src/msg/msg_private.h"
-#include "src/simix/smx_process_private.h"
-#include "src/simix/smx_private.hpp"
+#include "src/simix/ActorImpl.hpp"
+#include "src/simix/smx_private.h"
+#include "src/surf/HostImpl.hpp"
 #include "src/surf/cpu_interface.hpp"
-#include "src/surf/host_interface.hpp"
+#include "xbt/log.h"
 
-#include "simgrid/s4u/host.hpp"
-#include "simgrid/s4u/storage.hpp"
+XBT_LOG_EXTERNAL_CATEGORY(surf_route);
+
+std::map<std::string, simgrid::s4u::Host*> host_list; // FIXME: move it to Engine
 
-int MSG_HOST_LEVEL;
-int SD_HOST_LEVEL;
-int SIMIX_HOST_LEVEL;
-int ROUTING_HOST_LEVEL;
-int USER_HOST_LEVEL;
+int USER_HOST_LEVEL = -1;
 
 namespace simgrid {
+
+namespace xbt {
+template class Extendable<simgrid::s4u::Host>;
+}
+
 namespace s4u {
 
 simgrid::xbt::signal<void(Host&)> Host::onCreation;
 simgrid::xbt::signal<void(Host&)> Host::onDestruction;
 simgrid::xbt::signal<void(Host&)> Host::onStateChange;
+simgrid::xbt::signal<void(Host&)> Host::onSpeedChange;
 
 Host::Host(const char* name)
   : name_(name)
 {
+  xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name);
+  host_list[name_] = this;
+  new simgrid::surf::HostImpl(this);
+}
+
+Host::~Host()
+{
+  xbt_assert(currentlyDestroying_, "Please call h->destroy() instead of manually deleting it.");
+
+  delete pimpl_;
+  if (pimpl_netpoint != nullptr) // not removed yet by a children class
+    simgrid::s4u::Engine::instance()->netpointUnregister(pimpl_netpoint);
+  delete pimpl_cpu;
+  delete mounts;
 }
 
-Host::~Host() {
-       if (mounts != NULL)
-               delete mounts;
+/** @brief Fire the required callbacks and destroy the object
+ *
+ * Don't delete directly an Host, call h->destroy() instead.
+ *
+ * This is cumbersome but this is the simplest solution to ensure that the
+ * onDestruction() callback receives a valid object (because of the destructor
+ * order in a class hierarchy).
+ */
+void Host::destroy()
+{
+  if (!currentlyDestroying_) {
+    currentlyDestroying_ = true;
+    onDestruction(*this);
+    host_list.erase(name_);
+    delete this;
+  }
 }
 
-Host *Host::by_name(std::string name) {
-       Host* host = Host::by_name_or_null(name.c_str());
-       // TODO, raise an exception instead?
-       if (host == nullptr)
-               xbt_die("No such host: %s", name.c_str());
-       return host;
+Host* Host::by_name(std::string name)
+{
+  return host_list.at(name); // Will raise a std::out_of_range if the host does not exist
+}
+Host* Host::by_name_or_null(const char* name)
+{
+  return by_name_or_null(std::string(name));
+}
+Host* Host::by_name_or_null(std::string name)
+{
+  if (host_list.find(name) == host_list.end())
+    return nullptr;
+  return host_list.at(name);
 }
 
 Host *Host::current(){
-       smx_process_t smx_proc = SIMIX_process_self();
-       if (smx_proc == NULL)
-               xbt_die("Cannot call Host::current() from the maestro context");
-       return SIMIX_process_get_host(smx_proc);
+  smx_actor_t smx_proc = SIMIX_process_self();
+  if (smx_proc == nullptr)
+    xbt_die("Cannot call Host::current() from the maestro context");
+  return smx_proc->host;
 }
 
 void Host::turnOn() {
-       simgrid::simix::kernel(std::bind(SIMIX_host_on, this));
+  if (isOff()) {
+    simgrid::simix::kernelImmediate([this] {
+      this->extension<simgrid::simix::Host>()->turnOn();
+      this->pimpl_cpu->turnOn();
+      onStateChange(*this);
+    });
+  }
 }
 
 void Host::turnOff() {
-       simgrid::simix::simcall<void>(SIMCALL_HOST_OFF, this);
+  if (isOn()) {
+    smx_actor_t self = SIMIX_process_self();
+    simgrid::simix::kernelImmediate([this, self] {
+      SIMIX_host_off(this, self);
+      onStateChange(*this);
+    });
+  }
 }
 
 bool Host::isOn() {
-       return this->pimpl_cpu->isOn();
+  return this->pimpl_cpu->isOn();
 }
 
-int Host::getNbPStates() const {
-       return this->pimpl_cpu->getNbPStates();
+int Host::pstatesCount() const {
+  return this->pimpl_cpu->getNbPStates();
+}
+
+/**
+ * \brief Find a route toward another host
+ *
+ * \param dest [IN] where to
+ * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
+ * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
+ *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
+ * \pre links!=nullptr
+ *
+ * walk through the routing components tree and find a route between hosts
+ * by calling each "get_route" function in each routing component.
+ */
+void Host::routeTo(Host* dest, std::vector<Link*>* links, double* latency)
+{
+  std::vector<surf::LinkImpl*> linkImpls;
+  this->routeTo(dest, &linkImpls, latency);
+  for (surf::LinkImpl* l : linkImpls)
+    links->push_back(&l->piface_);
+}
+/** @brief Just like Host::routeTo, but filling an array of link implementations */
+void Host::routeTo(Host* dest, std::vector<surf::LinkImpl*>* links, double* latency)
+{
+  simgrid::kernel::routing::NetZoneImpl::getGlobalRoute(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
+  if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
+    XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", cname(), dest->cname(),
+               (latency == nullptr ? -1 : *latency));
+    for (auto link : *links)
+      XBT_CDEBUG(surf_route, "Link %s", link->cname());
+  }
 }
 
-boost::unordered_map<std::string, Storage*> &Host::mountedStorages() {
-       if (mounts == NULL) {
-               mounts = new boost::unordered_map<std::string, Storage*> ();
+boost::unordered_map<std::string, Storage*> const& Host::mountedStorages() {
+  if (mounts == nullptr) {
+    mounts = new boost::unordered_map<std::string, Storage*> ();
 
-               xbt_dict_t dict = this->getMountedStorageList();
+    xbt_dict_t dict = this->mountedStoragesAsDict();
 
-               xbt_dict_cursor_t cursor;
-               char *mountname;
-               char *storagename;
-               xbt_dict_foreach(dict, cursor, mountname, storagename) {
-                       mounts->insert({mountname, &Storage::byName(storagename)});
-               }
-               xbt_dict_free(&dict);
-       }
+    xbt_dict_cursor_t cursor;
+    char *mountname;
+    char *storagename;
+    xbt_dict_foreach(dict, cursor, mountname, storagename) {
+      mounts->insert({mountname, &Storage::byName(storagename)});
+    }
+    xbt_dict_free(&dict);
+  }
 
-       return *mounts;
+  return *mounts;
 }
 
 /** Get the properties assigned to a host */
-xbt_dict_t Host::getProperties() {
-  return simgrid::simix::kernel([&] {
-               simgrid::surf::Host* surf_host = this->extension<simgrid::surf::Host>();
-               return surf_host->getProperties();
-       });
+xbt_dict_t Host::properties() {
+  return simgrid::simix::kernelImmediate([this] {
+    return this->pimpl_->getProperties();
+  });
 }
 
-/** Get the processes attached to the host */
-xbt_swag_t Host::getProcessList()
-{
-  return simgrid::simix::kernel([&]() {
-    return ((smx_host_priv_t)this->extension(SIMIX_HOST_LEVEL))->process_list;
+/** Retrieve the property value (or nullptr if not set) */
+const char*Host::property(const char*key) {
+  return this->pimpl_->getProperty(key);
+}
+void Host::setProperty(const char*key, const char *value){
+  simgrid::simix::kernelImmediate([this, key, value] {
+    this->pimpl_->setProperty(key, value);
   });
 }
 
-/** Get the peak power of a host */
-double Host::getCurrentPowerPeak()
+/** Get the processes attached to the host */
+void Host::processes(std::vector<ActorPtr>* list)
 {
-  return simgrid::simix::kernel([&] {
-    return this->pimpl_cpu->getCurrentPowerPeak();
-  });
+  smx_actor_t actor = NULL;
+  xbt_swag_foreach(actor, this->extension<simgrid::simix::Host>()->process_list) {
+    list->push_back(actor->iface());
+  }
 }
 
-/** Get one power peak (in flops/s) of a host at a given pstate */
-double Host::getPowerPeakAt(int pstate_index)
+/** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
+double Host::getPstateSpeed(int pstate_index)
 {
-  return simgrid::simix::kernel([&] {
-    return this->pimpl_cpu->getPowerPeakAt(pstate_index);
+  return simgrid::simix::kernelImmediate([this, pstate_index] {
+    return this->pimpl_cpu->getPstateSpeed(pstate_index);
   });
 }
 
-/** @brief Get the speed of the cpu associated to a host */
-double Host::getSpeed() {
-       return pimpl_cpu->getSpeed(1.0);
-}
-/** @brief Returns the number of core of the processor. */
-int Host::getCoreAmount() {
-       return pimpl_cpu->getCore();
-}
-
-Host* Host::by_name_or_null(const char* name)
-{
-  return (Host*) xbt_dict_get_or_null(host_list, name);
+/** @brief Get the peak processor speed (in flops/s), at the current pstate */
+double Host::speed() {
+  return pimpl_cpu->getSpeed(1.0);
 }
 
-Host* Host::by_name_or_create(const char* name)
-{
-  Host* host = by_name_or_null(name);
-  if (host == nullptr) {
-    host = new Host(name);
-    xbt_dict_set(host_list, name, host, NULL);
-  }
-  return host;
+/** @brief Returns the number of core of the processor. */
+int Host::coreCount() {
+  return pimpl_cpu->coreCount();
 }
 
 /** @brief Set the pstate at which the host should run */
-void Host::setPState(int pstate_index)
+void Host::setPstate(int pstate_index)
 {
-  simgrid::simix::kernel(std::bind(
-      &simgrid::surf::Cpu::setPState, pimpl_cpu, pstate_index
-  ));
-}
-/** @brief Retrieve the pstate at which the host is currently running */
-int Host::getPState()
-{
-  return pimpl_cpu->getPState();
-}
-
-void Host::getParams(vm_params_t params)
-{
-  simgrid::simix::kernel([&]() {
-    this->extension<simgrid::surf::Host>()->getParams(params);
+  simgrid::simix::kernelImmediate([this, pstate_index] {
+      this->pimpl_cpu->setPState(pstate_index);
   });
 }
-
-void Host::setParams(vm_params_t params)
+/** @brief Retrieve the pstate at which the host is currently running */
+int Host::pstate()
 {
-  simgrid::simix::kernel([&]() {
-    this->extension<simgrid::surf::Host>()->setParams(params);
-  });
+  return this->pimpl_cpu->getPState();
 }
 
 /**
@@ -182,10 +238,10 @@ void Host::setParams(vm_params_t params)
  * \brief Returns the list of storages mounted on an host.
  * \return a dict containing all storages mounted on the host
  */
-xbt_dict_t Host::getMountedStorageList()
+xbt_dict_t Host::mountedStoragesAsDict()
 {
-  return simgrid::simix::kernel([&] {
-    return this->extension<simgrid::surf::Host>()->getMountedStorageList();
+  return simgrid::simix::kernelImmediate([this] {
+    return this->pimpl_->getMountedStorageList();
   });
 }
 
@@ -194,10 +250,10 @@ xbt_dict_t Host::getMountedStorageList()
  * \brief Returns the list of storages attached to an host.
  * \return a dict containing all storages attached to the host
  */
-xbt_dynar_t Host::getAttachedStorageList()
+void Host::attachedStorages(std::vector<const char*>* storages)
 {
-  return simgrid::simix::kernel([&] {
-    return this->extension<simgrid::surf::Host>()->getAttachedStorageList();
+  simgrid::simix::kernelImmediate([this, storages] { 
+     this->pimpl_->getAttachedStorageList(storages); 
   });
 }