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