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 std::unordered_map<std::string, std::string>* Host::get_properties()
 169 {
 170   return simix::simcall([this] { 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 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
 184  * The profile must contain boolean values. */
 185 void Host::set_state_profile(kernel::profile::Profile* p)
 186 {
 187   return simix::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
 188 }
 189 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
 190  *
 191  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
 192  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
 193  * at this pstate level) by the rate coming from the profile.
 194  */
 195 void Host::set_speed_profile(kernel::profile::Profile* p)
 196 {
 197   return simix::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
 198 }
 199
 200 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 201 double Host::get_pstate_speed(int pstate_index) const
 202 {
 203   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
 204 }
 205
 206 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
 207  *
 208  *  The amount of flops per second available for computing depends on several things:
 209  *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
 210  *      computing speed you would get at another pstate)
 211  *    - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
 212  * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
 213  *
 214  *  The remaining speed is then shared between the executions located on this host.
 215  *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
 216  *
 217  *  The host may have multiple cores, and your executions may be able to use more than a single core.
 218  *
 219  *  Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
 220  */
 221 double Host::get_speed() const
 222 {
 223   return this->pimpl_cpu->get_speed(1.0);
 224 }
 225 /** @brief Returns the current computation load (in flops per second)
 226  *
 227  * The external load (coming from an availability trace) is not taken in account.
 228  * You may also be interested in the load plugin.
 229  */
 230 double Host::get_load() const
 231 {
 232   return this->pimpl_cpu->get_load();
 233 }
 234 /** @brief Get the available speed ratio, between 0 and 1.
 235  *
 236  * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
 237  */
 238 double Host::get_available_speed() const
 239 {
 240   return this->pimpl_cpu->get_speed_ratio();
 241 }
 242
 243 /** @brief Returns the number of core of the processor. */
 244 int Host::get_core_count() const
 245 {
 246   return this->pimpl_cpu->get_core_count();
 247 }
 248
 249 /** @brief Set the pstate at which the host should run */
 250 void Host::set_pstate(int pstate_index)
 251 {
 252   simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 253 }
 254 /** @brief Retrieve the pstate at which the host is currently running */
 255 int Host::get_pstate() const
 256 {
 257   return this->pimpl_cpu->get_pstate();
 258 }
 259
 260 /**
 261  * @ingroup simix_storage_management
 262  * @brief Returns the list of storages attached to a host.
 263  * @return a vector containing all storages attached to the host
 264  */
 265 std::vector<const char*> Host::get_attached_storages() const
 266 {
 267   return simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
 268 }
 269
 270 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 271 {
 272   if (mounts_ == nullptr) {
 273     mounts_ = new std::unordered_map<std::string, Storage*>();
 274     for (auto const& m : this->pimpl_->storage_) {
 275       mounts_->insert({m.first, &m.second->piface_});
 276     }
 277   }
 278   return *mounts_;
 279 }
 280
 281 ExecPtr Host::exec_async(double flops)
 282 {
 283   return this_actor::exec_init(flops);
 284 }
 285
 286 void Host::execute(double flops)
 287 {
 288   execute(flops, 1.0 /* priority */);
 289 }
 290
 291 void Host::execute(double flops, double priority)
 292 {
 293   this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
 294 }
 295
 296 } // namespace s4u
 297 } // namespace simgrid
 298
 299 /* **************************** Public C interface *************************** */
 300 size_t sg_host_count()
 301 {
 302   return simgrid::s4u::Engine::get_instance()->get_host_count();
 303 }
 304 /** @brief Returns the host list
 305  *
 306  * Uses sg_host_count() to know the array size.
 307  *
 308  * @return an array of @ref sg_host_t containing all the hosts in the platform.
 309  * @remark The host order in this array is generally different from the
 310  * creation/declaration order in the XML platform (we use a hash table
 311  * internally).
 312  * @see sg_host_count()
 313  */
 314 sg_host_t* sg_host_list()
 315 {
 316   xbt_assert(sg_host_count() > 0, "There is no host!");
 317   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 318
 319   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 320   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 321
 322   return res;
 323 }
 324
 325 const char* sg_host_get_name(sg_host_t host)
 326 {
 327   return host->get_cname();
 328 }
 329
 330 void* sg_host_extension_get(sg_host_t host, size_t ext)
 331 {
 332   return host->extension(ext);
 333 }
 334
 335 size_t sg_host_extension_create(void (*deleter)(void*))
 336 {
 337   return simgrid::s4u::Host::extension_create(deleter);
 338 }
 339
 340 sg_host_t sg_host_by_name(const char* name)
 341 {
 342   return simgrid::s4u::Host::by_name_or_null(name);
 343 }
 344
 345 xbt_dynar_t sg_hosts_as_dynar()
 346 {
 347   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 348
 349   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 350     return not host || not host->pimpl_netpoint || not host->pimpl_netpoint->is_host();
 351   });
 352   std::sort(begin(list), last,
 353             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 354
 355   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 356   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 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->get_mounted_storages()) {
 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->get_speed();
 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->get_pstate_speed(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->get_core_count();
 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->get_pstate_count();
 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->get_pstate();
 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->set_pstate(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() 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->turn_on();
 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() 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->turn_off();
 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->is_on();
 496 }
 497
 498 /** @deprecated */
 499 int sg_host_is_off(sg_host_t host)
 500 {
 501   return not host->is_on();
 502 }
 503
 504 /** @brief Get the properties of a host */
 505 xbt_dict_t sg_host_get_properties(sg_host_t host)
 506 {
 507   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 508   std::unordered_map<std::string, std::string>* props = host->get_properties();
 509   if (props == nullptr)
 510     return nullptr;
 511   for (auto const& elm : *props) {
 512     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 513   }
 514   return as_dict;
 515 }
 516
 517 /** @ingroup m_host_management
 518  * @brief Returns the value of a given host property
 519  *
 520  * @param host a host
 521  * @param name a property name
 522  * @return value of a property (or nullptr if property not set)
 523  */
 524 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 525 {
 526   return host->get_property(name);
 527 }
 528
 529 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 530 {
 531   host->set_property(name, value);
 532 }
 533
 534 /**
 535  * @brief Find a route between two hosts
 536  *
 537  * @param from where from
 538  * @param to where to
 539  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 540  */
 541 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 542 {
 543   std::vector<simgrid::s4u::Link*> vlinks;
 544   from->route_to(to, vlinks, nullptr);
 545   for (auto const& link : vlinks)
 546     xbt_dynar_push(links, &link);
 547 }
 548 /**
 549  * @brief Find the latency of the route between two hosts
 550  *
 551  * @param from where from
 552  * @param to where to
 553  */
 554 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 555 {
 556   std::vector<simgrid::s4u::Link*> vlinks;
 557   double res = 0;
 558   from->route_to(to, vlinks, &res);
 559   return res;
 560 }
 561 /**
 562  * @brief Find the bandwitdh of the route between two hosts
 563  *
 564  * @param from where from
 565  * @param to where to
 566  */
 567 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 568 {
 569   double min_bandwidth = -1.0;
 570
 571   std::vector<simgrid::s4u::Link*> vlinks;
 572   from->route_to(to, vlinks, nullptr);
 573   for (auto const& link : vlinks) {
 574     double bandwidth = link->get_bandwidth();
 575     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 576       min_bandwidth = bandwidth;
 577   }
 578   return min_bandwidth;
 579 }
 580
 581 /** @brief Displays debugging information about a host */
 582 void sg_host_dump(sg_host_t host)
 583 {
 584   XBT_INFO("Displaying host %s", host->get_cname());
 585   XBT_INFO("  - speed: %.0f", host->get_speed());
 586   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 587   std::unordered_map<std::string, std::string>* props = host->get_properties();
 588
 589   if (not props->empty()) {
 590     XBT_INFO("  - properties:");
 591     for (auto const& elm : *props) {
 592       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 593     }
 594   }
 595 }
 596
 597 /** @brief Return the list of actors attached to a host.
 598  *
 599  * @param host a host
 600  * @param whereto a dynar in which we should push actors living on that host
 601  */
 602 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 603 {
 604   auto actors = host->get_all_actors();
 605   for (auto& actor : actors)
 606     xbt_dynar_push(whereto, &actor);
 607 }
 608
 609 sg_host_t sg_host_self()
 610 {
 611   smx_actor_t process = SIMIX_process_self();
 612   return (process == nullptr) ? nullptr : process->get_host();
 613 }
 614
 615 /* needs to be public and without simcall for exceptions and logging events */
 616 const char* sg_host_self_get_name()
 617 {
 618   sg_host_t host = sg_host_self();
 619   if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
 620     return "";
 621
 622   return host->get_cname();
 623 }
 624
 625 double sg_host_load(sg_host_t host)
 626 {
 627   return host->get_load();
 628 }