src/s4u/s4u_host.cpp

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