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.hpp"
  18 #include "src/simix/ActorImpl.hpp"
  19 #include "src/simix/smx_private.hpp"
  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(const char* name)
  85 {
  86   return host_list.at(std::string(name)); // Will raise a std::out_of_range if the host does not exist
  87 }
  88 Host* Host::by_name_or_null(const char* name)
  89 {
  90   return by_name_or_null(std::string(name));
  91 }
  92 Host* Host::by_name_or_null(std::string name)
  93 {
  94   auto host = host_list.find(name);
  95   return host == host_list.end() ? nullptr : host->second;
  96 }
  97
  98 Host *Host::current(){
  99   smx_actor_t smx_proc = SIMIX_process_self();
 100   if (smx_proc == nullptr)
 101     xbt_die("Cannot call Host::current() from the maestro context");
 102   return smx_proc->host;
 103 }
 104
 105 void Host::turnOn() {
 106   if (isOff()) {
 107     simgrid::simix::kernelImmediate([this] {
 108       this->extension<simgrid::simix::Host>()->turnOn();
 109       this->pimpl_cpu->turnOn();
 110       onStateChange(*this);
 111     });
 112   }
 113 }
 114
 115 void Host::turnOff() {
 116   if (isOn()) {
 117     smx_actor_t self = SIMIX_process_self();
 118     simgrid::simix::kernelImmediate([this, self] {
 119       SIMIX_host_off(this, self);
 120       onStateChange(*this);
 121     });
 122   }
 123 }
 124
 125 bool Host::isOn() {
 126   return this->pimpl_cpu->isOn();
 127 }
 128
 129 int Host::getPstatesCount() const
 130 {
 131   return this->pimpl_cpu->getNbPStates();
 132 }
 133
 134 /**
 135  * \brief Return the list of actors attached to an host.
 136  *
 137  * \param whereto a vector in which we should push actors living on that host
 138  */
 139 void Host::actorList(std::vector<ActorPtr>* whereto)
 140 {
 141   for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
 142     whereto->push_back(actor.ciface());
 143   }
 144 }
 145
 146 /**
 147  * \brief Find a route toward another host
 148  *
 149  * \param dest [IN] where to
 150  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 151  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 152  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 153  * \pre links!=nullptr
 154  *
 155  * walk through the routing components tree and find a route between hosts
 156  * by calling each "get_route" function in each routing component.
 157  */
 158 void Host::routeTo(Host* dest, std::vector<Link*>& links, double* latency)
 159 {
 160   std::vector<surf::LinkImpl*> linkImpls;
 161   this->routeTo(dest, linkImpls, latency);
 162   for (surf::LinkImpl* const& l : linkImpls)
 163     links.push_back(&l->piface_);
 164 }
 165
 166 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 167 void Host::routeTo(Host* dest, std::vector<surf::LinkImpl*>& links, double* latency)
 168 {
 169   simgrid::kernel::routing::NetZoneImpl::getGlobalRoute(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
 170   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 171     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", getCname(), dest->getCname(),
 172                (latency == nullptr ? -1 : *latency));
 173     for (auto const& link : links)
 174       XBT_CDEBUG(surf_route, "Link %s", link->getCname());
 175   }
 176 }
 177
 178 /** Get the properties assigned to a host */
 179 std::map<std::string, std::string>* Host::getProperties()
 180 {
 181   return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
 182 }
 183
 184 /** Retrieve the property value (or nullptr if not set) */
 185 const char* Host::getProperty(const char* key)
 186 {
 187   return this->pimpl_->getProperty(key);
 188 }
 189
 190 void Host::setProperty(std::string key, std::string value)
 191 {
 192   simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); });
 193 }
 194
 195 /** Get the processes attached to the host */
 196 void Host::getProcesses(std::vector<ActorPtr>* list)
 197 {
 198   for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
 199     list->push_back(actor.iface());
 200   }
 201 }
 202
 203 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 204 double Host::getPstateSpeed(int pstate_index)
 205 {
 206   return simgrid::simix::kernelImmediate([this, pstate_index] {
 207     return this->pimpl_cpu->getPstateSpeed(pstate_index);
 208   });
 209 }
 210
 211 /** @brief Get the peak processor speed (in flops/s), at the current pstate */
 212 double Host::getSpeed()
 213 {
 214   return pimpl_cpu->getSpeed(1.0);
 215 }
 216
 217 /** @brief Returns the number of core of the processor. */
 218 int Host::getCoreCount()
 219 {
 220   return pimpl_cpu->coreCount();
 221 }
 222
 223 /** @brief Set the pstate at which the host should run */
 224 void Host::setPstate(int pstate_index)
 225 {
 226   simgrid::simix::kernelImmediate([this, pstate_index] {
 227       this->pimpl_cpu->setPState(pstate_index);
 228   });
 229 }
 230 /** @brief Retrieve the pstate at which the host is currently running */
 231 int Host::getPstate()
 232 {
 233   return this->pimpl_cpu->getPState();
 234 }
 235
 236 /**
 237  * \ingroup simix_storage_management
 238  * \brief Returns the list of storages attached to an host.
 239  * \return a vector containing all storages attached to the host
 240  */
 241 void Host::getAttachedStorages(std::vector<const char*>* storages)
 242 {
 243   simgrid::simix::kernelImmediate([this, storages] {
 244      this->pimpl_->getAttachedStorageList(storages);
 245   });
 246 }
 247
 248 std::unordered_map<std::string, Storage*> const& Host::getMountedStorages()
 249 {
 250   if (mounts == nullptr) {
 251     mounts = new std::unordered_map<std::string, Storage*>();
 252     for (auto const& m : this->pimpl_->storage_) {
 253       mounts->insert({m.first, &m.second->piface_});
 254     }
 255   }
 256   return *mounts;
 257 }
 258
 259 void Host::execute(double flops)
 260 {
 261   Host* host_list[1]   = {this};
 262   double flops_list[1] = {flops};
 263   smx_activity_t s     = simcall_execution_parallel_start(nullptr /*name*/, 1, host_list, flops_list,
 264                                                       nullptr /*comm_sizes */, -1.0, -1 /*timeout*/);
 265   simcall_execution_wait(s);
 266 }
 267
 268 double Host::getLoad()
 269 {
 270   return this->pimpl_cpu->getLoad();
 271 }
 272
 273 } // namespace simgrid
 274 } // namespace s4u