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::on_creation;
  27 simgrid::xbt::signal<void(Host&)> Host::on_destruction;
  28 simgrid::xbt::signal<void(Host&)> Host::on_state_change;
  29 simgrid::xbt::signal<void(Host&)> Host::on_speed_change;
  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     on_destruction(*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::simcall([this] {
  96       this->extension<simgrid::simix::Host>()->turnOn();
  97       this->pimpl_cpu->turn_on();
  98       on_state_change(*this);
  99     });
 100   }
 101 }
 102
 103 /** @brief Stop the host if it is on */
 104 void Host::turnOff()
 105 {
 106   if (isOn()) {
 107     smx_actor_t self = SIMIX_process_self();
 108     simgrid::simix::simcall([this, self] {
 109       simgrid::simix::Host* host = this->extension<simgrid::simix::Host>();
 110
 111       xbt_assert((host != nullptr), "Invalid parameters");
 112
 113       this->pimpl_cpu->turn_off();
 114
 115       /* Clean Simulator data */
 116       if (not host->process_list.empty()) {
 117         for (auto& process : host->process_list) {
 118           SIMIX_process_kill(&process, self);
 119           XBT_DEBUG("Killing %s@%s on behalf of %s which turned off that host.", process.get_cname(),
 120                     process.host->get_cname(), self->get_cname());
 121         }
 122       }
 123
 124       on_state_change(*this);
 125     });
 126   }
 127 }
 128
 129 bool Host::isOn()
 130 {
 131   return this->pimpl_cpu->is_on();
 132 }
 133
 134 int Host::getPstatesCount() const
 135 {
 136   return this->pimpl_cpu->getNbPStates();
 137 }
 138
 139 /**
 140  * \brief Return the list of actors attached to an host.
 141  *
 142  * \param whereto a vector in which we should push actors living on that host
 143  */
 144 void Host::actorList(std::vector<ActorPtr>* whereto)
 145 {
 146   for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
 147     whereto->push_back(actor.ciface());
 148   }
 149 }
 150
 151 /**
 152  * \brief Find a route toward another host
 153  *
 154  * \param dest [IN] where to
 155  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 156  * \param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 157  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 158  * \pre links!=nullptr
 159  *
 160  * walk through the routing components tree and find a route between hosts
 161  * by calling each "get_route" function in each routing component.
 162  */
 163 void Host::routeTo(Host* dest, std::vector<Link*>& links, double* latency)
 164 {
 165   std::vector<kernel::resource::LinkImpl*> linkImpls;
 166   this->routeTo(dest, linkImpls, latency);
 167   for (kernel::resource::LinkImpl* const& l : linkImpls)
 168     links.push_back(&l->piface_);
 169 }
 170
 171 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 172 void Host::routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
 173 {
 174   simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
 175   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 176     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
 177                (latency == nullptr ? -1 : *latency));
 178     for (auto const& link : links)
 179       XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
 180   }
 181 }
 182
 183 /** Get the properties assigned to a host */
 184 std::map<std::string, std::string>* Host::getProperties()
 185 {
 186   return simgrid::simix::simcall([this] { return this->pimpl_->getProperties(); });
 187 }
 188
 189 /** Retrieve the property value (or nullptr if not set) */
 190 const char* Host::getProperty(const char* key)
 191 {
 192   return this->pimpl_->getProperty(key);
 193 }
 194
 195 void Host::setProperty(std::string key, std::string value)
 196 {
 197   simgrid::simix::simcall([this, key, value] { this->pimpl_->setProperty(key, value); });
 198 }
 199
 200 /** Get the processes attached to the host */
 201 void Host::getProcesses(std::vector<ActorPtr>* list)
 202 {
 203   for (auto& actor : this->extension<simgrid::simix::Host>()->process_list) {
 204     list->push_back(actor.iface());
 205   }
 206 }
 207
 208 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
 209 int Host::get_actor_count()
 210 {
 211   return this->extension<simgrid::simix::Host>()->process_list.size();
 212 }
 213
 214 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 215 double Host::getPstateSpeed(int pstate_index)
 216 {
 217   return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->getPstateSpeed(pstate_index); });
 218 }
 219
 220 /** @brief Get the peak processor speed (under full load (=1.0), in flops/s), at the current pstate */
 221 double Host::getSpeed()
 222 {
 223   return pimpl_cpu->getSpeed(1.0);
 224 }
 225 double Host::get_available_speed()
 226 {
 227   return pimpl_cpu->get_available_speed();
 228 }
 229
 230 /** @brief Returns the number of core of the processor. */
 231 int Host::getCoreCount()
 232 {
 233   return pimpl_cpu->coreCount();
 234 }
 235
 236 /** @brief Set the pstate at which the host should run */
 237 void Host::setPstate(int pstate_index)
 238 {
 239   simgrid::simix::simcall([this, pstate_index] { this->pimpl_cpu->setPState(pstate_index); });
 240 }
 241 /** @brief Retrieve the pstate at which the host is currently running */
 242 int Host::getPstate()
 243 {
 244   return this->pimpl_cpu->getPState();
 245 }
 246
 247 /**
 248  * \ingroup simix_storage_management
 249  * \brief Returns the list of storages attached to an host.
 250  * \return a vector containing all storages attached to the host
 251  */
 252 std::vector<const char*> Host::get_attached_storages()
 253 {
 254   return simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 255 }
 256
 257 void Host::getAttachedStorages(std::vector<const char*>* storages)
 258 {
 259   std::vector<const char*> local_storages =
 260       simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 261   for (auto elm : local_storages)
 262     storages->push_back(elm);
 263 }
 264
 265 std::unordered_map<std::string, Storage*> const& Host::getMountedStorages()
 266 {
 267   if (mounts_ == nullptr) {
 268     mounts_ = new std::unordered_map<std::string, Storage*>();
 269     for (auto const& m : this->pimpl_->storage_) {
 270       mounts_->insert({m.first, &m.second->piface_});
 271     }
 272   }
 273   return *mounts_;
 274 }
 275
 276 void Host::execute(double flops)
 277 {
 278   execute(flops, 1.0 /* priority */);
 279 }
 280 void Host::execute(double flops, double priority)
 281 {
 282   smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, this);
 283   simcall_execution_wait(s);
 284 }
 285
 286 double Host::getLoad()
 287 {
 288   return this->pimpl_cpu->get_load();
 289 }
 290
 291 } // namespace s4u
 292 } // namespace simgrid
 293
 294 /* **************************** Public C interface *************************** */
 295 size_t sg_host_count()
 296 {
 297   return simgrid::s4u::Engine::get_instance()->get_host_count();
 298 }
 299 /** @brief Returns the host list
 300  *
 301  * Uses sg_host_count() to know the array size.
 302  *
 303  * \return an array of \ref sg_host_t containing all the hosts in the platform.
 304  * \remark The host order in this array is generally different from the
 305  * creation/declaration order in the XML platform (we use a hash table
 306  * internally).
 307  * \see sg_host_count()
 308  */
 309 sg_host_t* sg_host_list()
 310 {
 311   xbt_assert(sg_host_count() > 0, "There is no host!");
 312   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 313
 314   sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
 315   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 316
 317   return res;
 318 }
 319
 320 const char* sg_host_get_name(sg_host_t host)
 321 {
 322   return host->get_cname();
 323 }
 324
 325 void* sg_host_extension_get(sg_host_t host, size_t ext)
 326 {
 327   return host->extension(ext);
 328 }
 329
 330 size_t sg_host_extension_create(void (*deleter)(void*))
 331 {
 332   return simgrid::s4u::Host::extension_create(deleter);
 333 }
 334
 335 sg_host_t sg_host_by_name(const char* name)
 336 {
 337   return simgrid::s4u::Host::by_name_or_null(name);
 338 }
 339
 340 static int hostcmp_voidp(const void* pa, const void* pb)
 341 {
 342   return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->get_cname(),
 343                 (*static_cast<simgrid::s4u::Host* const*>(pb))->get_cname());
 344 }
 345
 346 xbt_dynar_t sg_hosts_as_dynar()
 347 {
 348   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 349
 350   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 351
 352   for (auto const& host : list) {
 353     if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
 354       xbt_dynar_push(res, &host);
 355   }
 356   xbt_dynar_sort(res, hostcmp_voidp);
 357   return res;
 358 }
 359
 360 // ========= Layering madness ==============*
 361
 362 // ========== User data Layer ==========
 363 void* sg_host_user(sg_host_t host)
 364 {
 365   return host->extension(USER_HOST_LEVEL);
 366 }
 367 void sg_host_user_set(sg_host_t host, void* userdata)
 368 {
 369   host->extension_set(USER_HOST_LEVEL, userdata);
 370 }
 371 void sg_host_user_destroy(sg_host_t host)
 372 {
 373   host->extension_set(USER_HOST_LEVEL, nullptr);
 374 }
 375
 376 // ========= storage related functions ============
 377 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 378 {
 379   xbt_assert((host != nullptr), "Invalid parameters");
 380   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 381   for (auto const& elm : host->getMountedStorages()) {
 382     const char* mount_name = elm.first.c_str();
 383     sg_storage_t storage   = elm.second;
 384     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
 385   }
 386
 387   return res;
 388 }
 389
 390 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 391 {
 392   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 393   std::vector<const char*> storage_vector = host->get_attached_storages();
 394   for (auto const& name : storage_vector)
 395     xbt_dynar_push(storage_dynar, &name);
 396   return storage_dynar;
 397 }
 398
 399 // =========== user-level functions ===============
 400 // ================================================
 401 /** @brief Returns the total speed of a host */
 402 double sg_host_speed(sg_host_t host)
 403 {
 404   return host->getSpeed();
 405 }
 406
 407 /** \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 408  *
 409  * \param  host host to test
 410  * \param pstate_index pstate to test
 411  * \return Returns the processor speed associated with pstate_index
 412  */
 413 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 414 {
 415   return host->getPstateSpeed(pstate_index);
 416 }
 417
 418 /** \ingroup m_host_management
 419  * \brief Return the number of cores.
 420  *
 421  * \param host a host
 422  * \return the number of cores
 423  */
 424 int sg_host_core_count(sg_host_t host)
 425 {
 426   return host->getCoreCount();
 427 }
 428
 429 double sg_host_get_available_speed(sg_host_t host)
 430 {
 431   return host->get_available_speed();
 432 }
 433
 434 /** @brief Returns the number of power states for a host.
 435  *
 436  *  See also @ref plugin_energy.
 437  */
 438 int sg_host_get_nb_pstates(sg_host_t host)
 439 {
 440   return host->getPstatesCount();
 441 }
 442
 443 /** @brief Gets the pstate at which that host currently runs.
 444  *
 445  *  See also @ref plugin_energy.
 446  */
 447 int sg_host_get_pstate(sg_host_t host)
 448 {
 449   return host->getPstate();
 450 }
 451 /** @brief Sets the pstate at which that host should run.
 452  *
 453  *  See also @ref plugin_energy.
 454  */
 455 void sg_host_set_pstate(sg_host_t host, int pstate)
 456 {
 457   host->setPstate(pstate);
 458 }
 459
 460 /** \ingroup m_host_management
 461  *
 462  * \brief Start the host if it is off
 463  *
 464  * See also #sg_host_is_on() and #sg_host_is_off() to test the current state of the host and @ref plugin_energy
 465  * for more info on DVFS.
 466  */
 467 void sg_host_turn_on(sg_host_t host)
 468 {
 469   host->turnOn();
 470 }
 471
 472 /** \ingroup m_host_management
 473  *
 474  * \brief Stop the host if it is on
 475  *
 476  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
 477  * for more info on DVFS.
 478  */
 479 void sg_host_turn_off(sg_host_t host)
 480 {
 481   host->turnOff();
 482 }
 483
 484 /** @ingroup m_host_management
 485  * @brief Determine if a host is up and running.
 486  *
 487  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 488  * info on DVFS.
 489  *
 490  * @param host host to test
 491  * @return Returns true if the host is up and running, and false if it's currently down
 492  */
 493 int sg_host_is_on(sg_host_t host)
 494 {
 495   return host->isOn();
 496 }
 497
 498 /** @ingroup m_host_management
 499  * @brief Determine if a host is currently off.
 500  *
 501  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 502  * info on DVFS.
 503  */
 504 int sg_host_is_off(sg_host_t host)
 505 {
 506   return host->isOff();
 507 }
 508
 509 /** @brief Get the properties of an host */
 510 xbt_dict_t sg_host_get_properties(sg_host_t host)
 511 {
 512   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 513   std::map<std::string, std::string>* props = host->getProperties();
 514   if (props == nullptr)
 515     return nullptr;
 516   for (auto const& elm : *props) {
 517     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 518   }
 519   return as_dict;
 520 }
 521
 522 /** \ingroup m_host_management
 523  * \brief Returns the value of a given host property
 524  *
 525  * \param host a host
 526  * \param name a property name
 527  * \return value of a property (or nullptr if property not set)
 528 */
 529 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 530 {
 531   return host->getProperty(name);
 532 }
 533
 534 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 535 {
 536   host->setProperty(name, value);
 537 }
 538
 539 /**
 540  * \brief Find a route between two hosts
 541  *
 542  * \param from where from
 543  * \param to where to
 544  * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 545  */
 546 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 547 {
 548   std::vector<simgrid::s4u::Link*> vlinks;
 549   from->routeTo(to, vlinks, nullptr);
 550   for (auto const& link : vlinks)
 551     xbt_dynar_push(links, &link);
 552 }
 553 /**
 554  * \brief Find the latency of the route between two hosts
 555  *
 556  * \param from where from
 557  * \param to where to
 558  */
 559 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 560 {
 561   std::vector<simgrid::s4u::Link*> vlinks;
 562   double res = 0;
 563   from->routeTo(to, vlinks, &res);
 564   return res;
 565 }
 566 /**
 567  * \brief Find the bandwitdh of the route between two hosts
 568  *
 569  * \param from where from
 570  * \param to where to
 571  */
 572 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 573 {
 574   double min_bandwidth = -1.0;
 575
 576   std::vector<simgrid::s4u::Link*> vlinks;
 577   from->routeTo(to, vlinks, nullptr);
 578   for (auto const& link : vlinks) {
 579     double bandwidth = link->get_bandwidth();
 580     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 581       min_bandwidth = bandwidth;
 582   }
 583   return min_bandwidth;
 584 }
 585
 586 /** @brief Displays debugging information about a host */
 587 void sg_host_dump(sg_host_t host)
 588 {
 589   XBT_INFO("Displaying host %s", host->get_cname());
 590   XBT_INFO("  - speed: %.0f", host->getSpeed());
 591   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 592   std::map<std::string, std::string>* props = host->getProperties();
 593
 594   if (not props->empty()) {
 595     XBT_INFO("  - properties:");
 596     for (auto const& elm : *props) {
 597       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 598     }
 599   }
 600 }
 601
 602 /** \brief Return the list of actors attached to an host.
 603  *
 604  * \param host a host
 605  * \param whereto a dynar in which we should push actors living on that host
 606  */
 607 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 608 {
 609   for (auto& actor : host->extension<simgrid::simix::Host>()->process_list) {
 610     s4u_Actor* p = actor.ciface();
 611     xbt_dynar_push(whereto, &p);
 612   }
 613 }
 614
 615 sg_host_t sg_host_self()
 616 {
 617   smx_actor_t process = SIMIX_process_self();
 618   return (process == nullptr) ? nullptr : process->host;
 619 }