src/s4u/s4u_Host.cpp

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