src/s4u/s4u_host.cpp

   1 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #include <string>
   7 #include <functional>
   8 #include <stdexcept>
   9
  10 #include <map>
  11
  12 #include "simgrid/s4u/Engine.hpp"
  13 #include "simgrid/s4u/Host.hpp"
  14 #include "simgrid/s4u/Storage.hpp"
  15 #include "simgrid/simix.hpp"
  16 #include "src/kernel/routing/NetPoint.hpp"
  17 #include "src/msg/msg_private.h"
  18 #include "src/simix/ActorImpl.hpp"
  19 #include "src/simix/smx_private.h"
  20 #include "src/surf/HostImpl.hpp"
  21 #include "src/surf/cpu_interface.hpp"
  22 #include "xbt/log.h"
  23
  24 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
  25
  26 int USER_HOST_LEVEL = -1;
  27
  28 namespace simgrid {
  29
  30 namespace xbt {
  31 template class Extendable<simgrid::s4u::Host>;
  32 }
  33
  34 namespace s4u {
  35
  36 std::map<std::string, simgrid::s4u::Host*> host_list; // FIXME: move it to Engine
  37
  38 simgrid::xbt::signal<void(Host&)> Host::onCreation;
  39 simgrid::xbt::signal<void(Host&)> Host::onDestruction;
  40 simgrid::xbt::signal<void(Host&)> Host::onStateChange;
  41 simgrid::xbt::signal<void(Host&)> Host::onSpeedChange;
  42
  43 Host::Host(const char* name)
  44   : name_(name)
  45 {
  46   xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name);
  47   host_list[name_] = this;
  48   new simgrid::surf::HostImpl(this);
  49 }
  50
  51 Host::~Host()
  52 {
  53   xbt_assert(currentlyDestroying_, "Please call h->destroy() instead of manually deleting it.");
  54
  55   delete pimpl_;
  56   if (pimpl_netpoint != nullptr) // not removed yet by a children class
  57     simgrid::s4u::Engine::getInstance()->netpointUnregister(pimpl_netpoint);
  58   delete pimpl_cpu;
  59   delete mounts;
  60 }
  61
  62 /** @brief Fire the required callbacks and destroy the object
  63  *
  64  * Don't delete directly an Host, call h->destroy() instead.
  65  *
  66  * This is cumbersome but this is the simplest solution to ensure that the
  67  * onDestruction() callback receives a valid object (because of the destructor
  68  * order in a class hierarchy).
  69  */
  70 void Host::destroy()
  71 {
  72   if (not currentlyDestroying_) {
  73     currentlyDestroying_ = true;
  74     onDestruction(*this);
  75     host_list.erase(name_);
  76     delete this;
  77   }
  78 }
  79
  80 Host* Host::by_name(std::string name)
  81 {
  82   return host_list.at(name); // Will raise a std::out_of_range if the host does not exist
  83 }
  84 Host* Host::by_name_or_null(const char* name)
  85 {
  86   return by_name_or_null(std::string(name));
  87 }
  88 Host* Host::by_name_or_null(std::string name)
  89 {
  90   if (host_list.find(name) == host_list.end())
  91     return nullptr;
  92   return host_list.at(name);
  93 }
  94
  95 Host *Host::current(){
  96   smx_actor_t smx_proc = SIMIX_process_self();
  97   if (smx_proc == nullptr)
  98     xbt_die("Cannot call Host::current() from the maestro context");
  99   return smx_proc->host;
 100 }
 101
 102 void Host::turnOn() {
 103   if (isOff()) {
 104     simgrid::simix::kernelImmediate([this] {
 105       this->extension<simgrid::simix::Host>()->turnOn();
 106       this->pimpl_cpu->turnOn();
 107       onStateChange(*this);
 108     });
 109   }
 110 }
 111
 112 void Host::turnOff() {
 113   if (isOn()) {
 114     smx_actor_t self = SIMIX_process_self();
 115     simgrid::simix::kernelImmediate([this, self] {
 116       SIMIX_host_off(this, self);
 117       onStateChange(*this);
 118     });
 119   }
 120 }
 121
 122 bool Host::isOn() {
 123   return this->pimpl_cpu->isOn();
 124 }
 125
 126 int Host::getPstatesCount() const
 127 {
 128   return this->pimpl_cpu->getNbPStates();
 129 }
 130
 131 /**
 132  * \brief Return the list of actors attached to an host.
 133  *
 134  * \param whereto a vector in which we should push actors living on that host
 135  */
 136 void Host::actorList(std::vector<ActorPtr>* whereto)
 137 {
 138   smx_actor_t actor = NULL;
 139   xbt_swag_foreach(actor, this->extension<simgrid::simix::Host>()->process_list)
 140   {
 141     whereto->push_back(actor->ciface());
 142   }
 143 }
 144
 145 /**
 146  * \brief Find a route toward another host
 147  *
 148  * \param dest [IN] where to
 149  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 150  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 151  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 152  * \pre links!=nullptr
 153  *
 154  * walk through the routing components tree and find a route between hosts
 155  * by calling each "get_route" function in each routing component.
 156  */
 157 void Host::routeTo(Host* dest, std::vector<Link*>* links, double* latency)
 158 {
 159   std::vector<surf::LinkImpl*> linkImpls;
 160   this->routeTo(dest, &linkImpls, latency);
 161   for (surf::LinkImpl* l : linkImpls)
 162     links->push_back(&l->piface_);
 163 }
 164
 165 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 166 void Host::routeTo(Host* dest, std::vector<surf::LinkImpl*>* links, double* latency)
 167 {
 168   simgrid::kernel::routing::NetZoneImpl::getGlobalRoute(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
 169   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 170     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", getCname(), dest->getCname(),
 171                (latency == nullptr ? -1 : *latency));
 172     for (auto link : *links)
 173       XBT_CDEBUG(surf_route, "Link %s", link->cname());
 174   }
 175 }
 176
 177 /** Get the properties assigned to a host */
 178 xbt_dict_t Host::getProperties()
 179 {
 180   return simgrid::simix::kernelImmediate([this] {
 181     return this->pimpl_->getProperties();
 182   });
 183 }
 184
 185 /** Retrieve the property value (or nullptr if not set) */
 186 const char* Host::getProperty(const char* key)
 187 {
 188   return this->pimpl_->getProperty(key);
 189 }
 190
 191 void Host::setProperty(const char* key, const char* value)
 192 {
 193   simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); });
 194 }
 195
 196 /** Get the processes attached to the host */
 197 void Host::getProcesses(std::vector<ActorPtr>* list)
 198 {
 199   smx_actor_t actor = NULL;
 200   xbt_swag_foreach(actor, this->extension<simgrid::simix::Host>()->process_list) {
 201     list->push_back(actor->iface());
 202   }
 203 }
 204
 205 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 206 double Host::getPstateSpeed(int pstate_index)
 207 {
 208   return simgrid::simix::kernelImmediate([this, pstate_index] {
 209     return this->pimpl_cpu->getPstateSpeed(pstate_index);
 210   });
 211 }
 212
 213 /** @brief Get the peak processor speed (in flops/s), at the current pstate */
 214 double Host::getSpeed()
 215 {
 216   return pimpl_cpu->getSpeed(1.0);
 217 }
 218
 219 /** @brief Returns the number of core of the processor. */
 220 int Host::getCoreCount()
 221 {
 222   return pimpl_cpu->coreCount();
 223 }
 224
 225 /** @brief Set the pstate at which the host should run */
 226 void Host::setPstate(int pstate_index)
 227 {
 228   simgrid::simix::kernelImmediate([this, pstate_index] {
 229       this->pimpl_cpu->setPState(pstate_index);
 230   });
 231 }
 232 /** @brief Retrieve the pstate at which the host is currently running */
 233 int Host::getPstate()
 234 {
 235   return this->pimpl_cpu->getPState();
 236 }
 237
 238 /**
 239  * \ingroup simix_storage_management
 240  * \brief Returns the list of storages attached to an host.
 241  * \return a vector containing all storages attached to the host
 242  */
 243 void Host::getAttachedStorages(std::vector<const char*>* storages)
 244 {
 245   simgrid::simix::kernelImmediate([this, storages] {
 246      this->pimpl_->getAttachedStorageList(storages);
 247   });
 248 }
 249
 250 std::unordered_map<std::string, Storage*> const& Host::getMountedStorages()
 251 {
 252   if (mounts == nullptr) {
 253     mounts = new std::unordered_map<std::string, Storage*>();
 254     for (auto m : this->pimpl_->storage_) {
 255       mounts->insert({m.first, &m.second->piface_});
 256     }
 257   }
 258   return *mounts;
 259 }
 260
 261 } // namespace simgrid
 262 } // namespace s4u