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