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/simix/smx_private.hpp"
  13 #include "src/surf/HostImpl.hpp"
  14
  15 #include <algorithm>
  16 #include <string>
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
  19 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
  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     kernel::actor::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     kernel::actor::simcall([this] {
 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();
 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->piface_);
 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->pimpl_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 /**
 286  * @ingroup simix_storage_management
 287  * @brief Returns the list of storages attached to a host.
 288  * @return a vector containing all storages attached to the host
 289  */
 290 std::vector<const char*> Host::get_attached_storages() const
 291 {
 292   return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
 293 }
 294
 295 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 296 {
 297   if (mounts_ == nullptr) {
 298     mounts_ = new std::unordered_map<std::string, Storage*>();
 299     for (auto const& m : this->pimpl_->storage_) {
 300       mounts_->insert({m.first, &m.second->piface_});
 301     }
 302   }
 303   return *mounts_;
 304 }
 305
 306 ExecPtr Host::exec_async(double flops)
 307 {
 308   return this_actor::exec_init(flops);
 309 }
 310
 311 void Host::execute(double flops)
 312 {
 313   execute(flops, 1.0 /* priority */);
 314 }
 315
 316 void Host::execute(double flops, double priority)
 317 {
 318   this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
 319 }
 320
 321 } // namespace s4u
 322 } // namespace simgrid
 323
 324 /* **************************** Public C interface *************************** */
 325 size_t sg_host_count()
 326 {
 327   return simgrid::s4u::Engine::get_instance()->get_host_count();
 328 }
 329 /** @brief Returns the host list
 330  *
 331  * Uses sg_host_count() to know the array size.
 332  *
 333  * @return an array of @ref sg_host_t containing all the hosts in the platform.
 334  * @remark The host order in this array is generally different from the
 335  * creation/declaration order in the XML platform (we use a hash table
 336  * internally).
 337  * @see sg_host_count()
 338  */
 339 sg_host_t* sg_host_list()
 340 {
 341   xbt_assert(sg_host_count() > 0, "There is no host!");
 342   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 343
 344   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 345   memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
 346
 347   return res;
 348 }
 349
 350 const char* sg_host_get_name(sg_host_t host)
 351 {
 352   return host->get_cname();
 353 }
 354
 355 void* sg_host_extension_get(sg_host_t host, size_t ext)
 356 {
 357   return host->extension(ext);
 358 }
 359
 360 size_t sg_host_extension_create(void (*deleter)(void*))
 361 {
 362   return simgrid::s4u::Host::extension_create(deleter);
 363 }
 364
 365 sg_host_t sg_host_by_name(const char* name)
 366 {
 367   return simgrid::s4u::Host::by_name_or_null(name);
 368 }
 369
 370 xbt_dynar_t sg_hosts_as_dynar()
 371 {
 372   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 373
 374   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 375     return not host || not host->pimpl_netpoint || not host->pimpl_netpoint->is_host();
 376   });
 377   std::sort(begin(list), last,
 378             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 379
 380   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 381   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 382   return res;
 383 }
 384
 385 // ========= Layering madness ==============*
 386
 387 // ========== User data Layer ==========
 388 void* sg_host_data(sg_host_t host)
 389 {
 390   return host->get_data();
 391 }
 392 void sg_host_data_set(sg_host_t host, void* userdata)
 393 {
 394   host->set_data(userdata);
 395 }
 396 void* sg_host_user(sg_host_t host) // deprecated
 397 {
 398   return host->get_data();
 399 }
 400 void sg_host_user_set(sg_host_t host, void* userdata) // deprecated
 401 {
 402   host->set_data(userdata);
 403 }
 404 void sg_host_user_destroy(sg_host_t host) // deprecated
 405 {
 406   host->set_data(nullptr);
 407 }
 408
 409 // ========= storage related functions ============
 410 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 411 {
 412   xbt_assert((host != nullptr), "Invalid parameters");
 413   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 414   for (auto const& elm : host->get_mounted_storages()) {
 415     const char* mount_name = elm.first.c_str();
 416     sg_storage_t storage   = elm.second;
 417     xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
 418   }
 419
 420   return res;
 421 }
 422
 423 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
 424 {
 425   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 426   std::vector<const char*> storage_vector = host->get_attached_storages();
 427   for (auto const& name : storage_vector)
 428     xbt_dynar_push(storage_dynar, &name);
 429   return storage_dynar;
 430 }
 431
 432 // =========== user-level functions ===============
 433 // ================================================
 434 /** @brief Returns the total speed of a host */
 435 double sg_host_speed(sg_host_t host)
 436 {
 437   return host->get_speed();
 438 }
 439
 440 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 441  *
 442  * @param  host host to test
 443  * @param pstate_index pstate to test
 444  * @return Returns the processor speed associated with pstate_index
 445  */
 446 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
 447 {
 448   return host->get_pstate_speed(pstate_index);
 449 }
 450
 451 /** @ingroup m_host_management
 452  * @brief Return the number of cores.
 453  *
 454  * @param host a host
 455  * @return the number of cores
 456  */
 457 int sg_host_core_count(sg_host_t host)
 458 {
 459   return host->get_core_count();
 460 }
 461
 462 double sg_host_get_available_speed(sg_host_t host)
 463 {
 464   return host->get_available_speed();
 465 }
 466
 467 /** @brief Returns the number of power states for a host.
 468  *
 469  *  See also @ref plugin_energy.
 470  */
 471 int sg_host_get_nb_pstates(sg_host_t host)
 472 {
 473   return host->get_pstate_count();
 474 }
 475
 476 /** @brief Gets the pstate at which that host currently runs.
 477  *
 478  *  See also @ref plugin_energy.
 479  */
 480 int sg_host_get_pstate(sg_host_t host)
 481 {
 482   return host->get_pstate();
 483 }
 484 /** @brief Sets the pstate at which that host should run.
 485  *
 486  *  See also @ref plugin_energy.
 487  */
 488 void sg_host_set_pstate(sg_host_t host, int pstate)
 489 {
 490   host->set_pstate(pstate);
 491 }
 492
 493 /** @ingroup m_host_management
 494  *
 495  * @brief Start the host if it is off
 496  *
 497  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
 498  * for more info on DVFS.
 499  */
 500 void sg_host_turn_on(sg_host_t host)
 501 {
 502   host->turn_on();
 503 }
 504
 505 /** @ingroup m_host_management
 506  *
 507  * @brief Stop the host if it is on
 508  *
 509  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
 510  * for more info on DVFS.
 511  */
 512 void sg_host_turn_off(sg_host_t host)
 513 {
 514   host->turn_off();
 515 }
 516
 517 /** @ingroup m_host_management
 518  * @brief Determine if a host is up and running.
 519  *
 520  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 521  * info on DVFS.
 522  *
 523  * @param host host to test
 524  * @return Returns true if the host is up and running, and false if it's currently down
 525  */
 526 int sg_host_is_on(sg_host_t host)
 527 {
 528   return host->is_on();
 529 }
 530
 531 /** @deprecated */
 532 int sg_host_is_off(sg_host_t host)
 533 {
 534   return not host->is_on();
 535 }
 536
 537 /** @brief Get the properties of a host */
 538 xbt_dict_t sg_host_get_properties(sg_host_t host)
 539 {
 540   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 541   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 542   if (props == nullptr)
 543     return nullptr;
 544   for (auto const& elm : *props) {
 545     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 546   }
 547   return as_dict;
 548 }
 549
 550 /** @ingroup m_host_management
 551  * @brief Returns the value of a given host property
 552  *
 553  * @param host a host
 554  * @param name a property name
 555  * @return value of a property (or nullptr if property not set)
 556  */
 557 const char* sg_host_get_property_value(sg_host_t host, const char* name)
 558 {
 559   return host->get_property(name);
 560 }
 561
 562 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 563 {
 564   host->set_property(name, value);
 565 }
 566
 567 /**
 568  * @brief Find a route between two hosts
 569  *
 570  * @param from where from
 571  * @param to where to
 572  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 573  */
 574 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
 575 {
 576   std::vector<simgrid::s4u::Link*> vlinks;
 577   from->route_to(to, vlinks, nullptr);
 578   for (auto const& link : vlinks)
 579     xbt_dynar_push(links, &link);
 580 }
 581 /**
 582  * @brief Find the latency of the route between two hosts
 583  *
 584  * @param from where from
 585  * @param to where to
 586  */
 587 double sg_host_route_latency(sg_host_t from, sg_host_t to)
 588 {
 589   std::vector<simgrid::s4u::Link*> vlinks;
 590   double res = 0;
 591   from->route_to(to, vlinks, &res);
 592   return res;
 593 }
 594 /**
 595  * @brief Find the bandwitdh of the route between two hosts
 596  *
 597  * @param from where from
 598  * @param to where to
 599  */
 600 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
 601 {
 602   double min_bandwidth = -1.0;
 603
 604   std::vector<simgrid::s4u::Link*> vlinks;
 605   from->route_to(to, vlinks, nullptr);
 606   for (auto const& link : vlinks) {
 607     double bandwidth = link->get_bandwidth();
 608     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 609       min_bandwidth = bandwidth;
 610   }
 611   return min_bandwidth;
 612 }
 613
 614 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
 615 {
 616   from->send_to(to, byte_amount);
 617 }
 618
 619 /** @brief Displays debugging information about a host */
 620 void sg_host_dump(sg_host_t host)
 621 {
 622   XBT_INFO("Displaying host %s", host->get_cname());
 623   XBT_INFO("  - speed: %.0f", host->get_speed());
 624   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 625   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 626
 627   if (not props->empty()) {
 628     XBT_INFO("  - properties:");
 629     for (auto const& elm : *props) {
 630       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 631     }
 632   }
 633 }
 634
 635 /** @brief Return the list of actors attached to a host.
 636  *
 637  * @param host a host
 638  * @param whereto a dynar in which we should push actors living on that host
 639  */
 640 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
 641 {
 642   auto actors = host->get_all_actors();
 643   for (auto& actor : actors)
 644     xbt_dynar_push(whereto, &actor);
 645 }
 646
 647 sg_host_t sg_host_self()
 648 {
 649   smx_actor_t process = SIMIX_process_self();
 650   return (process == nullptr) ? nullptr : process->get_host();
 651 }
 652
 653 /* needs to be public and without simcall for exceptions and logging events */
 654 const char* sg_host_self_get_name()
 655 {
 656   sg_host_t host = sg_host_self();
 657   if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
 658     return "";
 659
 660   return host->get_cname();
 661 }
 662
 663 double sg_host_load(sg_host_t host)
 664 {
 665   return host->get_load();
 666 }