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