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