src/s4u/s4u_Host.cpp

   1 /* Copyright (c) 2006-2019. 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/Actor.hpp"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/s4u/Exec.hpp"
  10 #include "src/simix/smx_private.hpp"
  11 #include "src/surf/HostImpl.hpp"
  12
  13 #include <algorithm>
  14 #include <string>
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
  17 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
  18
  19 int USER_HOST_LEVEL = -1;
  20
  21 namespace simgrid {
  22 namespace xbt {
  23 template class Extendable<s4u::Host>;
  24 } // namespace xbt
  25
  26 namespace s4u {
  27
  28 xbt::signal<void(Host&)> Host::on_creation;
  29 xbt::signal<void(Host const&)> Host::on_destruction;
  30 xbt::signal<void(Host const&)> Host::on_state_change;
  31 xbt::signal<void(Host const&)> Host::on_speed_change;
  32
  33 Host::Host(const std::string& name) : name_(name)
  34 {
  35   xbt_assert(Host::by_name_or_null(name_) == nullptr, "Refusing to create a second host named '%s'.", get_cname());
  36   Engine::get_instance()->host_register(name_, this);
  37   new surf::HostImpl(this);
  38 }
  39
  40 Host::~Host()
  41 {
  42   xbt_assert(currently_destroying_, "Please call h->destroy() instead of manually deleting it.");
  43
  44   delete pimpl_;
  45   if (pimpl_netpoint != nullptr) // not removed yet by a children class
  46     Engine::get_instance()->netpoint_unregister(pimpl_netpoint);
  47   delete pimpl_cpu;
  48   delete mounts_;
  49 }
  50
  51 /** @brief Fire the required callbacks and destroy the object
  52  *
  53  * Don't delete directly a host, call h->destroy() instead.
  54  *
  55  * This is cumbersome but this is the simplest solution to ensure that the onDestruction() callback receives a valid
  56  * object (because of the destructor order in a class hierarchy).
  57  */
  58 void Host::destroy()
  59 {
  60   if (not currently_destroying_) {
  61     currently_destroying_ = true;
  62     on_destruction(*this);
  63     Engine::get_instance()->host_unregister(std::string(name_));
  64     delete this;
  65   }
  66 }
  67
  68 Host* Host::by_name(const std::string& name)
  69 {
  70   return Engine::get_instance()->host_by_name(name);
  71 }
  72 Host* Host::by_name_or_null(const std::string& name)
  73 {
  74   return Engine::get_instance()->host_by_name_or_null(name);
  75 }
  76
  77 Host* Host::current()
  78 {
  79   kernel::actor::ActorImpl* self = SIMIX_process_self();
  80   if (self == nullptr)
  81     xbt_die("Cannot call Host::current() from the maestro context");
  82   return self->get_host();
  83 }
  84
  85 void Host::turn_on()
  86 {
  87   if (not is_on()) {
  88     simix::simcall([this] {
  89       this->pimpl_cpu->turn_on();
  90       this->pimpl_->turn_on();
  91       on_state_change(*this);
  92     });
  93   }
  94 }
  95
  96 /** @brief Stop the host if it is on */
  97 void Host::turn_off()
  98 {
  99   if (is_on()) {
 100     simix::simcall([this] {
 101       this->pimpl_cpu->turn_off();
 102       this->pimpl_->turn_off();
 103
 104       on_state_change(*this);
 105     });
 106   }
 107 }
 108
 109 bool Host::is_on() const
 110 {
 111   return this->pimpl_cpu->is_on();
 112 }
 113
 114 int Host::get_pstate_count() const
 115 {
 116   return this->pimpl_cpu->get_pstate_count();
 117 }
 118
 119 /**
 120  * @brief Return a copy of the list of actors that are executing on this host.
 121  *
 122  * Daemons and regular actors are all mixed in this list.
 123  */
 124 std::vector<ActorPtr> Host::get_all_actors()
 125 {
 126   return pimpl_->get_all_actors();
 127 }
 128
 129 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
 130 int Host::get_actor_count()
 131 {
 132   return pimpl_->get_actor_count();
 133 }
 134
 135 /**
 136  * @brief Find a route toward another host
 137  *
 138  * @param dest [IN] where to
 139  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 140  * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 141  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 142  * @pre links!=nullptr
 143  *
 144  * walk through the routing components tree and find a route between hosts
 145  * by calling each "get_route" function in each routing component.
 146  */
 147 void Host::route_to(Host* dest, std::vector<Link*>& links, double* latency)
 148 {
 149   std::vector<kernel::resource::LinkImpl*> linkImpls;
 150   this->route_to(dest, linkImpls, latency);
 151   for (kernel::resource::LinkImpl* const& l : linkImpls)
 152     links.push_back(&l->piface_);
 153 }
 154
 155 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 156 void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
 157 {
 158   kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
 159   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 160     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
 161                (latency == nullptr ? -1 : *latency));
 162     for (auto const& link : links)
 163       XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
 164   }
 165 }
 166
 167 /** Get the properties assigned to a host */
 168 const std::unordered_map<std::string, std::string>* Host::get_properties() const
 169 {
 170   return this->pimpl_->get_properties();
 171 }
 172
 173 /** Retrieve the property value (or nullptr if not set) */
 174 const char* Host::get_property(const std::string& key) const
 175 {
 176   return this->pimpl_->get_property(key);
 177 }
 178
 179 void Host::set_property(const std::string& key, const std::string& value)
 180 {
 181   simix::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
 182 }
 183
 184 void Host::set_properties(const std::map<std::string, std::string>& properties)
 185 {
 186   simix::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
 187 }
 188
 189 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
 190  * The profile must contain boolean values. */
 191 void Host::set_state_profile(kernel::profile::Profile* p)
 192 {
 193   return simix::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
 194 }
 195 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
 196  *
 197  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
 198  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
 199  * at this pstate level) by the rate coming from the profile.
 200  */
 201 void Host::set_speed_profile(kernel::profile::Profile* p)
 202 {
 203   return simix::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
 204 }
 205
 206 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 207 double Host::get_pstate_speed(int pstate_index) const
 208 {
 209   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
 210 }
 211
 212 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
 213  *
 214  *  The amount of flops per second available for computing depends on several things:
 215  *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
 216  *      computing speed you would get at another pstate)
 217  *    - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
 218  * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
 219  *
 220  *  The remaining speed is then shared between the executions located on this host.
 221  *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
 222  *
 223  *  The host may have multiple cores, and your executions may be able to use more than a single core.
 224  *
 225  *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
 226  */
 227 double Host::get_speed() const
 228 {
 229   return this->pimpl_cpu->get_speed(1.0);
 230 }
 231 /** @brief Returns the current computation load (in flops per second)
 232  *
 233  * The external load (coming from an availability trace) is not taken in account.
 234  * You may also be interested in the load plugin.
 235  */
 236 double Host::get_load() const
 237 {
 238   return this->pimpl_cpu->get_load();
 239 }
 240 /** @brief Get the available speed ratio, between 0 and 1.
 241  *
 242  * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
 243  */
 244 double Host::get_available_speed() const
 245 {
 246   return this->pimpl_cpu->get_speed_ratio();
 247 }
 248
 249 /** @brief Returns the number of core of the processor. */
 250 int Host::get_core_count() const
 251 {
 252   return this->pimpl_cpu->get_core_count();
 253 }
 254
 255 /** @brief Set the pstate at which the host should run */
 256 void Host::set_pstate(int pstate_index)
 257 {
 258   simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 259 }
 260 /** @brief Retrieve the pstate at which the host is currently running */
 261 int Host::get_pstate() const
 262 {
 263   return this->pimpl_cpu->get_pstate();
 264 }
 265
 266 /**
 267  * @ingroup simix_storage_management
 268  * @brief Returns the list of storages attached to a host.
 269  * @return a vector containing all storages attached to the host
 270  */
 271 std::vector<const char*> Host::get_attached_storages() const
 272 {
 273   return simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 274 }
 275
 276 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 277 {
 278   if (mounts_ == nullptr) {
 279     mounts_ = new std::unordered_map<std::string, Storage*>();
 280     for (auto const& m : this->pimpl_->storage_) {
 281       mounts_->insert({m.first, &m.second->piface_});
 282     }
 283   }
 284   return *mounts_;
 285 }
 286
 287 ExecPtr Host::exec_async(double flops)
 288 {
 289   return this_actor::exec_init(flops);
 290 }
 291
 292 void Host::execute(double flops)
 293 {
 294   execute(flops, 1.0 /* priority */);
 295 }
 296
 297 void Host::execute(double flops, double priority)
 298 {
 299   this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
 300 }
 301
 302 } // namespace s4u
 303 } // namespace simgrid
 304
 305 /* **************************** Public C interface *************************** */
 306 size_t sg_host_count()
 307 {
 308   return simgrid::s4u::Engine::get_instance()->get_host_count();
 309 }
 310 /** @brief Returns the host list
 311  *
 312  * Uses sg_host_count() to know the array size.
 313  *
 314  * @return an array of @ref sg_host_t containing all the hosts in the platform.
 315  * @remark The host order in this array is generally different from the
 316  * creation/declaration order in the XML platform (we use a hash table
 317  * internally).
 318  * @see sg_host_count()
 319  */
 320 sg_host_t* sg_host_list()
 321 {
 322   xbt_assert(sg_host_count() > 0, "There is no host!");
 323   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 324
 325   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 326   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 327
 328   return res;
 329 }
 330
 331 const char* sg_host_get_name(sg_host_t host)
 332 {
 333   return host->get_cname();
 334 }
 335
 336 void* sg_host_extension_get(sg_host_t host, size_t ext)
 337 {
 338   return host->extension(ext);
 339 }
 340
 341 size_t sg_host_extension_create(void (*deleter)(void*))
 342 {
 343   return simgrid::s4u::Host::extension_create(deleter);
 344 }
 345
 346 sg_host_t sg_host_by_name(const char* name)
 347 {
 348   return simgrid::s4u::Host::by_name_or_null(name);
 349 }
 350
 351 xbt_dynar_t sg_hosts_as_dynar()
 352 {
 353   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 354
 355   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 356     return not host || not host->pimpl_netpoint || not host->pimpl_netpoint->is_host();
 357   });
 358   std::sort(begin(list), last,
 359             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 360
 361   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 362   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 363   return res;
 364 }
 365
 366 // ========= Layering madness ==============*
 367
 368 // ========== User data Layer ==========
 369 void* sg_host_user(sg_host_t host)
 370 {
 371   return host->extension(USER_HOST_LEVEL);
 372 }
 373 void sg_host_user_set(sg_host_t host, void* userdata)
 374 {
 375   host->extension_set(USER_HOST_LEVEL, userdata);
 376 }
 377 void sg_host_user_destroy(sg_host_t host)
 378 {
 379   host->extension_set(USER_HOST_LEVEL, nullptr);
 380 }
 381
 382 // ========= storage related functions ============
 383 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 384 {
 385   xbt_assert((host != nullptr), "Invalid parameters");
 386   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 387   for (auto const& elm : host->get_mounted_storages()) {
 388     const char* mount_name = elm.first.c_str();
 389     sg_storage_t storage   = elm.second;
 390     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
 391   }
 392
 393   return res;
 394 }
 395
 396 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 397 {
 398   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 399   std::vector<const char*> storage_vector = host->get_attached_storages();
 400   for (auto const& name : storage_vector)
 401     xbt_dynar_push(storage_dynar, &name);
 402   return storage_dynar;
 403 }
 404
 405 // =========== user-level functions ===============
 406 // ================================================
 407 /** @brief Returns the total speed of a host */
 408 double sg_host_speed(sg_host_t host)
 409 {
 410   return host->get_speed();
 411 }
 412
 413 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 414  *
 415  * @param  host host to test
 416  * @param pstate_index pstate to test
 417  * @return Returns the processor speed associated with pstate_index
 418  */
 419 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 420 {
 421   return host->get_pstate_speed(pstate_index);
 422 }
 423
 424 /** @ingroup m_host_management
 425  * @brief Return the number of cores.
 426  *
 427  * @param host a host
 428  * @return the number of cores
 429  */
 430 int sg_host_core_count(sg_host_t host)
 431 {
 432   return host->get_core_count();
 433 }
 434
 435 double sg_host_get_available_speed(sg_host_t host)
 436 {
 437   return host->get_available_speed();
 438 }
 439
 440 /** @brief Returns the number of power states for a host.
 441  *
 442  *  See also @ref plugin_energy.
 443  */
 444 int sg_host_get_nb_pstates(sg_host_t host)
 445 {
 446   return host->get_pstate_count();
 447 }
 448
 449 /** @brief Gets the pstate at which that host currently runs.
 450  *
 451  *  See also @ref plugin_energy.
 452  */
 453 int sg_host_get_pstate(sg_host_t host)
 454 {
 455   return host->get_pstate();
 456 }
 457 /** @brief Sets the pstate at which that host should run.
 458  *
 459  *  See also @ref plugin_energy.
 460  */
 461 void sg_host_set_pstate(sg_host_t host, int pstate)
 462 {
 463   host->set_pstate(pstate);
 464 }
 465
 466 /** @ingroup m_host_management
 467  *
 468  * @brief Start the host if it is off
 469  *
 470  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
 471  * for more info on DVFS.
 472  */
 473 void sg_host_turn_on(sg_host_t host)
 474 {
 475   host->turn_on();
 476 }
 477
 478 /** @ingroup m_host_management
 479  *
 480  * @brief Stop the host if it is on
 481  *
 482  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
 483  * for more info on DVFS.
 484  */
 485 void sg_host_turn_off(sg_host_t host)
 486 {
 487   host->turn_off();
 488 }
 489
 490 /** @ingroup m_host_management
 491  * @brief Determine if a host is up and running.
 492  *
 493  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 494  * info on DVFS.
 495  *
 496  * @param host host to test
 497  * @return Returns true if the host is up and running, and false if it's currently down
 498  */
 499 int sg_host_is_on(sg_host_t host)
 500 {
 501   return host->is_on();
 502 }
 503
 504 /** @deprecated */
 505 int sg_host_is_off(sg_host_t host)
 506 {
 507   return not host->is_on();
 508 }
 509
 510 /** @brief Get the properties of a host */
 511 xbt_dict_t sg_host_get_properties(sg_host_t host)
 512 {
 513   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 514   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 515   if (props == nullptr)
 516     return nullptr;
 517   for (auto const& elm : *props) {
 518     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 519   }
 520   return as_dict;
 521 }
 522
 523 /** @ingroup m_host_management
 524  * @brief Returns the value of a given host property
 525  *
 526  * @param host a host
 527  * @param name a property name
 528  * @return value of a property (or nullptr if property not set)
 529  */
 530 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 531 {
 532   return host->get_property(name);
 533 }
 534
 535 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 536 {
 537   host->set_property(name, value);
 538 }
 539
 540 /**
 541  * @brief Find a route between two hosts
 542  *
 543  * @param from where from
 544  * @param to where to
 545  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 546  */
 547 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 548 {
 549   std::vector<simgrid::s4u::Link*> vlinks;
 550   from->route_to(to, vlinks, nullptr);
 551   for (auto const& link : vlinks)
 552     xbt_dynar_push(links, &link);
 553 }
 554 /**
 555  * @brief Find the latency of the route between two hosts
 556  *
 557  * @param from where from
 558  * @param to where to
 559  */
 560 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 561 {
 562   std::vector<simgrid::s4u::Link*> vlinks;
 563   double res = 0;
 564   from->route_to(to, vlinks, &res);
 565   return res;
 566 }
 567 /**
 568  * @brief Find the bandwitdh of the route between two hosts
 569  *
 570  * @param from where from
 571  * @param to where to
 572  */
 573 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 574 {
 575   double min_bandwidth = -1.0;
 576
 577   std::vector<simgrid::s4u::Link*> vlinks;
 578   from->route_to(to, vlinks, nullptr);
 579   for (auto const& link : vlinks) {
 580     double bandwidth = link->get_bandwidth();
 581     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 582       min_bandwidth = bandwidth;
 583   }
 584   return min_bandwidth;
 585 }
 586
 587 /** @brief Displays debugging information about a host */
 588 void sg_host_dump(sg_host_t host)
 589 {
 590   XBT_INFO("Displaying host %s", host->get_cname());
 591   XBT_INFO("  - speed: %.0f", host->get_speed());
 592   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 593   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 594
 595   if (not props->empty()) {
 596     XBT_INFO("  - properties:");
 597     for (auto const& elm : *props) {
 598       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 599     }
 600   }
 601 }
 602
 603 /** @brief Return the list of actors attached to a host.
 604  *
 605  * @param host a host
 606  * @param whereto a dynar in which we should push actors living on that host
 607  */
 608 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 609 {
 610   auto actors = host->get_all_actors();
 611   for (auto& actor : actors)
 612     xbt_dynar_push(whereto, &actor);
 613 }
 614
 615 sg_host_t sg_host_self()
 616 {
 617   smx_actor_t process = SIMIX_process_self();
 618   return (process == nullptr) ? nullptr : process->get_host();
 619 }
 620
 621 /* needs to be public and without simcall for exceptions and logging events */
 622 const char* sg_host_self_get_name()
 623 {
 624   sg_host_t host = sg_host_self();
 625   if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
 626     return "";
 627
 628   return host->get_cname();
 629 }
 630
 631 double sg_host_load(sg_host_t host)
 632 {
 633   return host->get_load();
 634 }