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 on_destruction() 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 double Host::get_speed() const
 231 {
 232   return this->pimpl_cpu->get_speed(1.0);
 233 }
 234 double Host::get_load() const
 235 {
 236   return this->pimpl_cpu->get_load();
 237 }
 238 double Host::get_available_speed() const
 239 {
 240   return this->pimpl_cpu->get_speed_ratio();
 241 }
 242
 243 int Host::get_core_count() const
 244 {
 245   return this->pimpl_cpu->get_core_count();
 246 }
 247
 248 /** @brief Set the pstate at which the host should run */
 249 void Host::set_pstate(int pstate_index)
 250 {
 251   kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 252 }
 253 /** @brief Retrieve the pstate at which the host is currently running */
 254 int Host::get_pstate() const
 255 {
 256   return this->pimpl_cpu->get_pstate();
 257 }
 258
 259 std::vector<Disk*> Host::get_disks() const
 260 {
 261   return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
 262 }
 263
 264 void Host::add_disk(Disk* disk)
 265 {
 266   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 267 }
 268
 269 void Host::remove_disk(const std::string& disk_name)
 270 {
 271   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
 272 }
 273 /**
 274  * @ingroup simix_storage_management
 275  * @brief Returns the list of storages attached to a host.
 276  * @return a vector containing all storages attached to the host
 277  */
 278 std::vector<const char*> Host::get_attached_storages() const
 279 {
 280   return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
 281 }
 282
 283 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
 284 {
 285   if (mounts_ == nullptr)
 286     mounts_ = pimpl_->get_mounted_storages();
 287
 288   return *mounts_;
 289 }
 290
 291 ExecPtr Host::exec_async(double flops)
 292 {
 293   return this_actor::exec_init(flops);
 294 }
 295
 296 void Host::execute(double flops)
 297 {
 298   execute(flops, 1.0 /* priority */);
 299 }
 300
 301 void Host::execute(double flops, double priority)
 302 {
 303   this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
 304 }
 305
 306 } // namespace s4u
 307 } // namespace simgrid
 308
 309 /* **************************** Public C interface *************************** */
 310 size_t sg_host_count()
 311 {
 312   return simgrid::s4u::Engine::get_instance()->get_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(const_sg_host_t host)
 326 {
 327   return host->get_cname();
 328 }
 329
 330 void* sg_host_extension_get(const_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->get_netpoint() || not host->get_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_data(const_sg_host_t host)
 364 {
 365   return host->get_data();
 366 }
 367 void sg_host_data_set(sg_host_t host, void* userdata)
 368 {
 369   host->set_data(userdata);
 370 }
 371 void* sg_host_user(sg_host_t host) // deprecated
 372 {
 373   return host->get_data();
 374 }
 375 void sg_host_user_set(sg_host_t host, void* userdata) // deprecated
 376 {
 377   host->set_data(userdata);
 378 }
 379 void sg_host_user_destroy(sg_host_t host) // deprecated
 380 {
 381   host->set_data(nullptr);
 382 }
 383
 384 // ========= storage related functions ============
 385 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
 386 {
 387   xbt_assert((host != nullptr), "Invalid parameters");
 388   xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
 389   for (auto const& elm : host->get_mounted_storages()) {
 390     const char* mount_name = elm.first.c_str();
 391     const simgrid::s4u::Storage* storage = elm.second;
 392     xbt_dict_set(res, mount_name, (void*)storage->get_cname());
 393   }
 394
 395   return res;
 396 }
 397
 398 xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host)
 399 {
 400   xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
 401   std::vector<const char*> storage_vector = host->get_attached_storages();
 402   for (auto const& name : storage_vector)
 403     xbt_dynar_push(storage_dynar, &name);
 404   return storage_dynar;
 405 }
 406
 407 // =========== user-level functions ===============
 408 // ================================================
 409 /** @brief Returns the total speed of a host */
 410 double sg_host_speed(const_sg_host_t host)
 411 {
 412   return host->get_speed();
 413 }
 414
 415 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 416  *
 417  * @param  host host to test
 418  * @param pstate_index pstate to test
 419  * @return Returns the processor speed associated with pstate_index
 420  */
 421 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
 422 {
 423   return host->get_pstate_speed(pstate_index);
 424 }
 425
 426 /** @ingroup m_host_management
 427  * @brief Return the number of cores.
 428  *
 429  * @param host a host
 430  * @return the number of cores
 431  */
 432 int sg_host_core_count(const_sg_host_t host)
 433 {
 434   return host->get_core_count();
 435 }
 436
 437 double sg_host_get_available_speed(const_sg_host_t host)
 438 {
 439   return host->get_available_speed();
 440 }
 441
 442 /** @brief Returns the number of power states for a host.
 443  *
 444  *  See also @ref plugin_energy.
 445  */
 446 int sg_host_get_nb_pstates(const_sg_host_t host)
 447 {
 448   return host->get_pstate_count();
 449 }
 450
 451 /** @brief Gets the pstate at which that host currently runs.
 452  *
 453  *  See also @ref plugin_energy.
 454  */
 455 int sg_host_get_pstate(const_sg_host_t host)
 456 {
 457   return host->get_pstate();
 458 }
 459 /** @brief Sets the pstate at which that host should run.
 460  *
 461  *  See also @ref plugin_energy.
 462  */
 463 void sg_host_set_pstate(sg_host_t host, int pstate)
 464 {
 465   host->set_pstate(pstate);
 466 }
 467
 468 /** @ingroup m_host_management
 469  *
 470  * @brief Start the host if it is off
 471  *
 472  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
 473  * for more info on DVFS.
 474  */
 475 void sg_host_turn_on(sg_host_t host)
 476 {
 477   host->turn_on();
 478 }
 479
 480 /** @ingroup m_host_management
 481  *
 482  * @brief Stop the host if it is on
 483  *
 484  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
 485  * for more info on DVFS.
 486  */
 487 void sg_host_turn_off(sg_host_t host)
 488 {
 489   host->turn_off();
 490 }
 491
 492 /** @ingroup m_host_management
 493  * @brief Determine if a host is up and running.
 494  *
 495  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 496  * info on DVFS.
 497  *
 498  * @param host host to test
 499  * @return Returns true if the host is up and running, and false if it's currently down
 500  */
 501 int sg_host_is_on(const_sg_host_t host)
 502 {
 503   return host->is_on();
 504 }
 505
 506 /** @brief Get the properties of a host */
 507 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
 508 {
 509   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 510   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 511   if (props == nullptr)
 512     return nullptr;
 513   for (auto const& elm : *props) {
 514     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
 515   }
 516   return as_dict;
 517 }
 518
 519 /** @ingroup m_host_management
 520  * @brief Returns the value of a given host property
 521  *
 522  * @param host a host
 523  * @param name a property name
 524  * @return value of a property (or nullptr if property not set)
 525  */
 526 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
 527 {
 528   return host->get_property(name);
 529 }
 530
 531 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 532 {
 533   host->set_property(name, value);
 534 }
 535
 536 /**
 537  * @brief Find a route between two hosts
 538  *
 539  * @param from where from
 540  * @param to where to
 541  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 542  */
 543 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
 544 {
 545   std::vector<simgrid::s4u::Link*> vlinks;
 546   from->route_to(to, vlinks, nullptr);
 547   for (auto const& link : vlinks)
 548     xbt_dynar_push(links, &link);
 549 }
 550 /**
 551  * @brief Find the latency of the route between two hosts
 552  *
 553  * @param from where from
 554  * @param to where to
 555  */
 556 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
 557 {
 558   std::vector<simgrid::s4u::Link*> vlinks;
 559   double res = 0;
 560   from->route_to(to, vlinks, &res);
 561   return res;
 562 }
 563 /**
 564  * @brief Find the bandwidth of the route between two hosts
 565  *
 566  * @param from where from
 567  * @param to where to
 568  */
 569 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
 570 {
 571   double min_bandwidth = -1.0;
 572
 573   std::vector<simgrid::s4u::Link*> vlinks;
 574   from->route_to(to, vlinks, nullptr);
 575   for (auto const& link : vlinks) {
 576     double bandwidth = link->get_bandwidth();
 577     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 578       min_bandwidth = bandwidth;
 579   }
 580   return min_bandwidth;
 581 }
 582
 583 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
 584 {
 585   from->send_to(to, byte_amount);
 586 }
 587
 588 /** @brief Displays debugging information about a host */
 589 void sg_host_dump(const_sg_host_t host)
 590 {
 591   XBT_INFO("Displaying host %s", host->get_cname());
 592   XBT_INFO("  - speed: %.0f", host->get_speed());
 593   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
 594   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 595
 596   if (not props->empty()) {
 597     XBT_INFO("  - properties:");
 598     for (auto const& elm : *props) {
 599       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
 600     }
 601   }
 602 }
 603
 604 /** @brief Return the list of actors attached to a host.
 605  *
 606  * @param host a host
 607  * @param whereto a dynar in which we should push actors living on that host
 608  */
 609 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
 610 {
 611   auto const actors = host->get_all_actors();
 612   for (auto const& actor : actors)
 613     xbt_dynar_push(whereto, &actor);
 614 }
 615
 616 sg_host_t sg_host_self()
 617 {
 618   return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
 619 }
 620
 621 /* needs to be public and without simcall for exceptions and logging events */
 622 const char* sg_host_self_get_name()
 623 {
 624   const char* res = "";
 625   if (not SIMIX_is_maestro()) {
 626     const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
 627     if (host != nullptr)
 628       res = host->get_cname();
 629   }
 630   return res;
 631 }
 632
 633 double sg_host_load(const_sg_host_t host)
 634 {
 635   return host->get_load();
 636 }