src/s4u/s4u_Host.cpp

   1 /* Copyright (c) 2006-2018. 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 "simgrid/kernel/routing/NetPoint.hpp"
   7 #include "simgrid/s4u/Engine.hpp"
   8 #include "src/simix/smx_host_private.hpp"
   9 #include "src/surf/HostImpl.hpp"
  10
  11 #include <string>
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
  14 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
  15
  16 int USER_HOST_LEVEL = -1;
  17
  18 namespace simgrid {
  19
  20 namespace xbt {
  21 template class Extendable<simgrid::s4u::Host>;
  22 }
  23
  24 namespace s4u {
  25
  26 simgrid::xbt::signal<void(Host&)> Host::onCreation;
  27 simgrid::xbt::signal<void(Host&)> Host::onDestruction;
  28 simgrid::xbt::signal<void(Host&)> Host::onStateChange;
  29 simgrid::xbt::signal<void(Host&)> Host::onSpeedChange;
  30
  31 Host::Host(const char* name) : name_(name)
  32 {
  33   xbt_assert(Host::by_name_or_null(name) == nullptr, "Refusing to create a second host named '%s'.", name);
  34   Engine::get_instance()->host_register(std::string(name_), this);
  35   new simgrid::surf::HostImpl(this);
  36 }
  37
  38 Host::~Host()
  39 {
  40   xbt_assert(currentlyDestroying_, "Please call h->destroy() instead of manually deleting it.");
  41
  42   delete pimpl_;
  43   if (pimpl_netpoint != nullptr) // not removed yet by a children class
  44     simgrid::s4u::Engine::get_instance()->netpoint_unregister(pimpl_netpoint);
  45   delete pimpl_cpu;
  46   delete mounts;
  47 }
  48
  49 /** @brief Fire the required callbacks and destroy the object
  50  *
  51  * Don't delete directly an Host, call h->destroy() instead.
  52  *
  53  * This is cumbersome but this is the simplest solution to ensure that the
  54  * onDestruction() callback receives a valid object (because of the destructor
  55  * order in a class hierarchy).
  56  */
  57 void Host::destroy()
  58 {
  59   if (not currentlyDestroying_) {
  60     currentlyDestroying_ = true;
  61     onDestruction(*this);
  62     Engine::get_instance()->host_unregister(std::string(name_));
  63     delete this;
  64   }
  65 }
  66
  67 Host* Host::by_name(std::string name)
  68 {
  69   return Engine::get_instance()->host_by_name(name);
  70 }
  71 Host* Host::by_name(const char* name)
  72 {
  73   return Engine::get_instance()->host_by_name(std::string(name));
  74 }
  75 Host* Host::by_name_or_null(const char* name)
  76 {
  77   return Engine::get_instance()->host_by_name_or_null(std::string(name));
  78 }
  79 Host* Host::by_name_or_null(std::string name)
  80 {
  81   return Engine::get_instance()->host_by_name_or_null(name);
  82 }
  83
  84 Host* Host::current()
  85 {
  86   smx_actor_t smx_proc = SIMIX_process_self();
  87   if (smx_proc == nullptr)
  88     xbt_die("Cannot call Host::current() from the maestro context");
  89   return smx_proc->host;
  90 }
  91
  92 void Host::turnOn()
  93 {
  94   if (isOff()) {
  95     simgrid::simix::kernelImmediate([this] {
  96       this->extension<simgrid::simix::Host>()->turnOn();
  97       this->pimpl_cpu->turn_on();
  98       onStateChange(*this);
  99     });
 100   }
 101 }
 102
 103 void Host::turnOff()
 104 {
 105   if (isOn()) {
 106     smx_actor_t self = SIMIX_process_self();
 107     simgrid::simix::kernelImmediate([this, self] {
 108       SIMIX_host_off(this, self);
 109       onStateChange(*this);
 110     });
 111   }
 112 }
 113
 114 bool Host::isOn()
 115 {
 116   return this->pimpl_cpu->is_on();
 117 }
 118
 119 int Host::getPstatesCount() const
 120 {
 121   return this->pimpl_cpu->getNbPStates();
 122 }
 123
 124 /**
 125  * \brief Return the list of actors attached to an host.
 126  *
 127  * \param whereto a vector in which we should push actors living on that host
 128  */
 129 void Host::actorList(std::vector<ActorPtr>* whereto)
 130 {
 131   for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
 132     whereto->push_back(actor.ciface());
 133   }
 134 }
 135
 136 /**
 137  * \brief Find a route toward another host
 138  *
 139  * \param dest [IN] where to
 140  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 141  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 142  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 143  * \pre links!=nullptr
 144  *
 145  * walk through the routing components tree and find a route between hosts
 146  * by calling each "get_route" function in each routing component.
 147  */
 148 void Host::routeTo(Host* dest, std::vector<Link*>& links, double* latency)
 149 {
 150   std::vector<kernel::resource::LinkImpl*> linkImpls;
 151   this->routeTo(dest, linkImpls, latency);
 152   for (kernel::resource::LinkImpl* const& l : linkImpls)
 153     links.push_back(&l->piface_);
 154 }
 155
 156 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 157 void Host::routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
 158 {
 159   simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
 160   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 161     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
 162                (latency == nullptr ? -1 : *latency));
 163     for (auto const& link : links)
 164       XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
 165   }
 166 }
 167
 168 /** Get the properties assigned to a host */
 169 std::map<std::string, std::string>* Host::getProperties()
 170 {
 171   return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
 172 }
 173
 174 /** Retrieve the property value (or nullptr if not set) */
 175 const char* Host::getProperty(const char* key)
 176 {
 177   return this->pimpl_->getProperty(key);
 178 }
 179
 180 void Host::setProperty(std::string key, std::string value)
 181 {
 182   simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); });
 183 }
 184
 185 /** Get the processes attached to the host */
 186 void Host::getProcesses(std::vector<ActorPtr>* list)
 187 {
 188   for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
 189     list->push_back(actor.iface());
 190   }
 191 }
 192
 193 /** @brief Returns how many actors have been launched on this host */
 194 // FIXME: Specify whether the user should expect only non-daemon actors here!
 195 int Host::get_actor_count()
 196 {
 197   return this->extension<simgrid::simix::Host>()->process_list.size();
 198 }
 199
 200 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 201 double Host::getPstateSpeed(int pstate_index)
 202 {
 203   return simgrid::simix::kernelImmediate(
 204       [this, pstate_index] { return this->pimpl_cpu->getPstateSpeed(pstate_index); });
 205 }
 206
 207 /** @brief Get the peak processor speed (under full load (=1.0), 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] { this->pimpl_cpu->setPState(pstate_index); });
 223 }
 224 /** @brief Retrieve the pstate at which the host is currently running */
 225 int Host::getPstate()
 226 {
 227   return this->pimpl_cpu->getPState();
 228 }
 229
 230 /**
 231  * \ingroup simix_storage_management
 232  * \brief Returns the list of storages attached to an host.
 233  * \return a vector containing all storages attached to the host
 234  */
 235 std::vector<const char*> Host::get_attached_storages()
 236 {
 237   return simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); });
 238 }
 239
 240 void Host::getAttachedStorages(std::vector<const char*>* storages)
 241 {
 242   std::vector<const char*> local_storages =
 243       simgrid::simix::kernelImmediate([this] { return this->pimpl_->get_attached_storages(); });
 244   for (auto elm : local_storages)
 245     storages->push_back(elm);
 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->get_load();
 271 }
 272
 273 } // namespace s4u
 274 } // namespace simgrid
 275
 276 /* **************************** Public C interface *************************** */
 277 size_t sg_host_count()
 278 {
 279   return simgrid::s4u::Engine::get_instance()->get_host_count();
 280 }
 281 /** @brief Returns the host list
 282  *
 283  * Uses sg_host_count() to know the array size.
 284  *
 285  * \return an array of \ref sg_host_t containing all the hosts in the platform.
 286  * \remark The host order in this array is generally different from the
 287  * creation/declaration order in the XML platform (we use a hash table
 288  * internally).
 289  * \see sg_host_count()
 290  */
 291 sg_host_t* sg_host_list()
 292 {
 293   xbt_assert(sg_host_count() > 0, "There is no host!");
 294   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 295
 296   sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
 297   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 298
 299   return res;
 300 }
 301
 302 const char* sg_host_get_name(sg_host_t host)
 303 {
 304   return host->get_cname();
 305 }
 306
 307 void* sg_host_extension_get(sg_host_t host, size_t ext)
 308 {
 309   return host->extension(ext);
 310 }
 311
 312 size_t sg_host_extension_create(void (*deleter)(void*))
 313 {
 314   return simgrid::s4u::Host::extension_create(deleter);
 315 }
 316
 317 sg_host_t sg_host_by_name(const char* name)
 318 {
 319   return simgrid::s4u::Host::by_name_or_null(name);
 320 }
 321
 322 static int hostcmp_voidp(const void* pa, const void* pb)
 323 {
 324   return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->get_cname(),
 325                 (*static_cast<simgrid::s4u::Host* const*>(pb))->get_cname());
 326 }
 327
 328 xbt_dynar_t sg_hosts_as_dynar()
 329 {
 330   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 331
 332   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 333
 334   for (auto const& host : list) {
 335     if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
 336       xbt_dynar_push(res, &host);
 337   }
 338   xbt_dynar_sort(res, hostcmp_voidp);
 339   return res;
 340 }
 341
 342 // ========= Layering madness ==============*
 343
 344 // ========== User data Layer ==========
 345 void* sg_host_user(sg_host_t host)
 346 {
 347   return host->extension(USER_HOST_LEVEL);
 348 }
 349 void sg_host_user_set(sg_host_t host, void* userdata)
 350 {
 351   host->extension_set(USER_HOST_LEVEL, userdata);
 352 }
 353 void sg_host_user_destroy(sg_host_t host)
 354 {
 355   host->extension_set(USER_HOST_LEVEL, nullptr);
 356 }
 357
 358 // ========= storage related functions ============
 359 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 360 {
 361   xbt_assert((host != nullptr), "Invalid parameters");
 362   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 363   for (auto const& elm : host->getMountedStorages()) {
 364     const char* mount_name = elm.first.c_str();
 365     sg_storage_t storage   = elm.second;
 366     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
 367   }
 368
 369   return res;
 370 }
 371
 372 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 373 {
 374   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 375   std::vector<const char*> storage_vector = host->get_attached_storages();
 376   for (auto const& name : storage_vector)
 377     xbt_dynar_push(storage_dynar, &name);
 378   return storage_dynar;
 379 }
 380
 381 // =========== user-level functions ===============
 382 // ================================================
 383 /** @brief Returns the total speed of a host */
 384 double sg_host_speed(sg_host_t host)
 385 {
 386   return host->getSpeed();
 387 }
 388
 389 /** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 390  *
 391  * \param  host host to test
 392  * \param pstate_index pstate to test
 393  * \return Returns the processor speed associated with pstate_index
 394  */
 395 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 396 {
 397   return host->getPstateSpeed(pstate_index);
 398 }
 399
 400 /** \ingroup m_host_management
 401  * \brief Return the number of cores.
 402  *
 403  * \param host a host
 404  * \return the number of cores
 405  */
 406 int sg_host_core_count(sg_host_t host)
 407 {
 408   return host->getCoreCount();
 409 }
 410
 411 double sg_host_get_available_speed(sg_host_t host)
 412 {
 413   return host->pimpl_cpu->get_available_speed();
 414 }
 415
 416 /** @brief Returns the number of power states for a host.
 417  *
 418  *  See also @ref plugin_energy.
 419  */
 420 int sg_host_get_nb_pstates(sg_host_t host)
 421 {
 422   return host->getPstatesCount();
 423 }
 424
 425 /** @brief Gets the pstate at which that host currently runs.
 426  *
 427  *  See also @ref plugin_energy.
 428  */
 429 int sg_host_get_pstate(sg_host_t host)
 430 {
 431   return host->getPstate();
 432 }
 433 /** @brief Sets the pstate at which that host should run.
 434  *
 435  *  See also @ref plugin_energy.
 436  */
 437 void sg_host_set_pstate(sg_host_t host, int pstate)
 438 {
 439   host->setPstate(pstate);
 440 }
 441
 442 /** \ingroup m_host_management
 443  *
 444  * \brief Start the host if it is off
 445  *
 446  * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy
 447  * for more info on DVFS.
 448  */
 449 void sg_host_turn_on(sg_host_t host)
 450 {
 451   host->turnOn();
 452 }
 453
 454 /** \ingroup m_host_management
 455  *
 456  * \brief Stop the host if it is on
 457  *
 458  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
 459  * for more info on DVFS.
 460  */
 461 void sg_host_turn_off(sg_host_t host)
 462 {
 463   host->turnOff();
 464 }
 465
 466 /** @ingroup m_host_management
 467  * @brief Determine if a host is up and running.
 468  *
 469  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 470  * info on DVFS.
 471  *
 472  * @param host host to test
 473  * @return Returns true if the host is up and running, and false if it's currently down
 474  */
 475 int sg_host_is_on(sg_host_t host)
 476 {
 477   return host->isOn();
 478 }
 479
 480 /** @ingroup m_host_management
 481  * @brief Determine if a host is currently off.
 482  *
 483  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 484  * info on DVFS.
 485  */
 486 int sg_host_is_off(sg_host_t host)
 487 {
 488   return host->isOff();
 489 }
 490
 491 /** @brief Get the properties of an host */
 492 xbt_dict_t sg_host_get_properties(sg_host_t host)
 493 {
 494   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 495   std::map<std::string, std::string>* props = host->getProperties();
 496   if (props == nullptr)
 497     return nullptr;
 498   for (auto const& elm : *props) {
 499     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 500   }
 501   return as_dict;
 502 }
 503
 504 /** \ingroup m_host_management
 505  * \brief Returns the value of a given host property
 506  *
 507  * \param host a host
 508  * \param name a property name
 509  * \return value of a property (or nullptr if property not set)
 510 */
 511 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 512 {
 513   return host->getProperty(name);
 514 }
 515
 516 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 517 {
 518   host->setProperty(name, value);
 519 }
 520
 521 /**
 522  * \brief Find a route between two hosts
 523  *
 524  * \param from where from
 525  * \param to where to
 526  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 527  */
 528 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 529 {
 530   std::vector<simgrid::s4u::Link*> vlinks;
 531   from->routeTo(to, vlinks, nullptr);
 532   for (auto const& link : vlinks)
 533     xbt_dynar_push(links, &link);
 534 }
 535 /**
 536  * \brief Find the latency of the route between two hosts
 537  *
 538  * \param from where from
 539  * \param to where to
 540  */
 541 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 542 {
 543   std::vector<simgrid::s4u::Link*> vlinks;
 544   double res = 0;
 545   from->routeTo(to, vlinks, &res);
 546   return res;
 547 }
 548 /**
 549  * \brief Find the bandwitdh of the route between two hosts
 550  *
 551  * \param from where from
 552  * \param to where to
 553  */
 554 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 555 {
 556   double min_bandwidth = -1.0;
 557
 558   std::vector<simgrid::s4u::Link*> vlinks;
 559   from->routeTo(to, vlinks, nullptr);
 560   for (auto const& link : vlinks) {
 561     double bandwidth = link->bandwidth();
 562     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 563       min_bandwidth = bandwidth;
 564   }
 565   return min_bandwidth;
 566 }
 567
 568 /** @brief Displays debugging information about a host */
 569 void sg_host_dump(sg_host_t host)
 570 {
 571   XBT_INFO("Displaying host %s", host->get_cname());
 572   XBT_INFO("  - speed: %.0f", host->getSpeed());
 573   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 574   std::map<std::string, std::string>* props = host->getProperties();
 575
 576   if (not props->empty()) {
 577     XBT_INFO("  - properties:");
 578     for (auto const& elm : *props) {
 579       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 580     }
 581   }
 582 }
 583
 584 /** \brief Return the list of actors attached to an host.
 585  *
 586  * \param host a host
 587  * \param whereto a dynar in which we should push actors living on that host
 588  */
 589 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 590 {
 591   for (auto& actor : host->extension<simgrid::simix::Host>()->process_list) {
 592     s4u_Actor* p = actor.ciface();
 593     xbt_dynar_push(whereto, &p);
 594   }
 595 }
 596
 597 sg_host_t sg_host_self()
 598 {
 599   smx_actor_t process = SIMIX_process_self();
 600   return (process == nullptr) ? nullptr : process->host;
 601 }