src/s4u/s4u_Host.cpp

   1 /* Copyright (c) 2006-2021. 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/Exception.hpp"
   7 #include "simgrid/host.h"
   8 #include "simgrid/kernel/routing/NetPoint.hpp"
   9 #include "simgrid/s4u/Actor.hpp"
  10 #include "simgrid/s4u/Comm.hpp"
  11 #include "simgrid/s4u/Engine.hpp"
  12 #include "simgrid/s4u/Exec.hpp"
  13 #include "simgrid/s4u/VirtualMachine.hpp"
  14 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  15 #include "src/surf/HostImpl.hpp"
  16 #include "xbt/parse_units.hpp"
  17
  18 #include <algorithm>
  19 #include <string>
  20
  21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
  22 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
  23
  24 namespace simgrid {
  25
  26 template class xbt::Extendable<s4u::Host>;
  27
  28 namespace s4u {
  29
  30 xbt::signal<void(Host&)> Host::on_creation;
  31 xbt::signal<void(Host const&)> Host::on_destruction;
  32 xbt::signal<void(Host const&)> Host::on_state_change;
  33 xbt::signal<void(Host const&)> Host::on_speed_change;
  34
  35 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
  36 {
  37   pimpl_netpoint_ = netpoint;
  38   return this;
  39 }
  40
  41 Host::~Host()
  42 {
  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 }
  47
  48 /** @brief Fire the required callbacks and destroy the object
  49  *
  50  * Don't delete directly a host, call h->destroy() instead.
  51  *
  52  * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
  53  * object (because of the destructor order in a class hierarchy).
  54  */
  55 void Host::destroy()
  56 {
  57   kernel::actor::simcall([this] { this->pimpl_->destroy(); });
  58 }
  59
  60 Host* Host::by_name(const std::string& name)
  61 {
  62   return Engine::get_instance()->host_by_name(name);
  63 }
  64 Host* Host::by_name_or_null(const std::string& name)
  65 {
  66   return Engine::get_instance()->host_by_name_or_null(name);
  67 }
  68
  69 Host* Host::current()
  70 {
  71   kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
  72   if (self == nullptr)
  73     xbt_die("Cannot call Host::current() from the maestro context");
  74   return self->get_host();
  75 }
  76
  77 void Host::turn_on()
  78 {
  79   if (not is_on()) {
  80     kernel::actor::simcall([this] {
  81       this->pimpl_cpu->turn_on();
  82       this->pimpl_->turn_on();
  83       on_state_change(*this);
  84     });
  85   }
  86 }
  87
  88 /** @brief Stop the host if it is on */
  89 void Host::turn_off()
  90 {
  91   if (is_on()) {
  92     const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
  93     kernel::actor::simcall([this, self] {
  94       for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
  95         if (vm->get_pm() == this) {
  96           vm->shutdown();
  97           vm->turn_off();
  98         }
  99       this->pimpl_cpu->turn_off();
 100       this->pimpl_->turn_off(self);
 101
 102       on_state_change(*this);
 103     });
 104   }
 105 }
 106
 107 bool Host::is_on() const
 108 {
 109   return this->pimpl_cpu->is_on();
 110 }
 111
 112 int Host::get_pstate_count() const
 113 {
 114   return this->pimpl_cpu->get_pstate_count();
 115 }
 116
 117 /**
 118  * @brief Return a copy of the list of actors that are executing on this host.
 119  *
 120  * Daemons and regular actors are all mixed in this list.
 121  */
 122 std::vector<ActorPtr> Host::get_all_actors() const
 123 {
 124   return pimpl_->get_all_actors();
 125 }
 126
 127 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
 128 int Host::get_actor_count() const
 129 {
 130   return pimpl_->get_actor_count();
 131 }
 132
 133 /**
 134  * @brief Find a route toward another host
 135  *
 136  * @param dest [IN] where to
 137  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 138  * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
 139  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
 140  * @pre links!=nullptr
 141  *
 142  * walk through the routing components tree and find a route between hosts
 143  * by calling each "get_route" function in each routing component.
 144  */
 145 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
 146 {
 147   std::vector<kernel::resource::LinkImpl*> linkImpls;
 148   this->route_to(dest, linkImpls, latency);
 149   for (auto* l : linkImpls)
 150     links.push_back(l->get_iface());
 151 }
 152
 153 /** @brief Just like Host::routeTo, but filling an array of link implementations */
 154 void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const
 155 {
 156   kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
 157   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
 158     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
 159                (latency == nullptr ? -1 : *latency));
 160     for (auto const* link : links)
 161       XBT_CDEBUG(surf_route, "  Link '%s'", link->get_cname());
 162   }
 163 }
 164
 165 /** @brief Returns the networking zone englobing that host */
 166 NetZone* Host::get_englobing_zone()
 167 {
 168   return pimpl_netpoint_->get_englobing_zone()->get_iface();
 169 }
 170
 171 void Host::sendto(Host* dest, double byte_amount) // deprecated 331
 172 {
 173   Comm::sendto_async(this, dest, byte_amount)->wait();
 174 }
 175
 176 CommPtr Host::sendto_async(Host* dest, double byte_amount) // deprecated 331
 177 {
 178   return Comm::sendto_async(this, dest, byte_amount);
 179 }
 180
 181 void Host::send_to(Host* dest, double byte_amount) // deprecated 330
 182 {
 183   Comm::sendto(this, dest, byte_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 Host* 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   return this;
 202 }
 203
 204 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
 205 {
 206   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
 207   return this;
 208 }
 209
 210 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
 211  * The profile must contain boolean values. */
 212 Host* Host::set_state_profile(kernel::profile::Profile* p)
 213 {
 214   kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
 215   return this;
 216 }
 217 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
 218  *
 219  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
 220  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
 221  * at this pstate level) by the rate coming from the profile.
 222  */
 223 Host* Host::set_speed_profile(kernel::profile::Profile* p)
 224 {
 225   kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
 226   return this;
 227 }
 228
 229 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 230 double Host::get_pstate_speed(int pstate_index) const
 231 {
 232   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
 233 }
 234
 235 double Host::get_speed() const
 236 {
 237   return this->pimpl_cpu->get_speed(1.0);
 238 }
 239 double Host::get_load() const
 240 {
 241   return this->pimpl_cpu->get_load();
 242 }
 243 double Host::get_available_speed() const
 244 {
 245   return this->pimpl_cpu->get_speed_ratio();
 246 }
 247
 248 int Host::get_core_count() const
 249 {
 250   return this->pimpl_cpu->get_core_count();
 251 }
 252
 253 Host* Host::set_core_count(int core_count)
 254 {
 255   kernel::actor::simcall([this, core_count] { this->pimpl_cpu->set_core_count(core_count); });
 256   return this;
 257 }
 258
 259 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
 260 {
 261   kernel::actor::simcall([this, &speed_per_state] { pimpl_cpu->set_pstate_speed(speed_per_state); });
 262   return this;
 263 }
 264
 265 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
 266 {
 267   std::vector<double> speed_list(speed_per_state.size());
 268   for (const auto& speed_str : speed_per_state) {
 269     try {
 270       double speed = xbt_parse_get_speed("", 0, speed_str.c_str(), nullptr, "");
 271       speed_list.push_back(speed);
 272     } catch (const simgrid::ParseError& e) {
 273       xbt_die("Host(%s): Impossible to set_pstate_speed, invalid speed %s", get_cname(), speed_str.c_str());
 274     }
 275   }
 276   set_pstate_speed(speed_list);
 277   return this;
 278 }
 279
 280 /** @brief Set the pstate at which the host should run */
 281 Host* Host::set_pstate(int pstate_index)
 282 {
 283   kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
 284   return this;
 285 }
 286
 287 /** @brief Retrieve the pstate at which the host is currently running */
 288 int Host::get_pstate() const
 289 {
 290   return this->pimpl_cpu->get_pstate();
 291 }
 292
 293 std::vector<Disk*> Host::get_disks() const
 294 {
 295   return this->pimpl_->get_disks();
 296 }
 297
 298 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
 299 {
 300   auto disk =
 301       this->get_netpoint()->get_englobing_zone()->get_disk_model()->create_disk(name, read_bandwidth, write_bandwidth);
 302   return disk->set_host(this)->get_iface();
 303 }
 304
 305 void Host::add_disk(const Disk* disk)
 306 {
 307   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 308 }
 309
 310 void Host::remove_disk(const std::string& disk_name)
 311 {
 312   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
 313 }
 314
 315 ExecPtr Host::exec_init(double flops) const
 316 {
 317   return this_actor::exec_init(flops);
 318 }
 319
 320 ExecPtr Host::exec_async(double flops) const
 321 {
 322   return this_actor::exec_async(flops);
 323 }
 324
 325 void Host::execute(double flops) const
 326 {
 327   execute(flops, 1.0 /* priority */);
 328 }
 329
 330 void Host::execute(double flops, double priority) const
 331 {
 332   this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_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 sg_host_t* sg_host_list()
 344 {
 345   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
 346   size_t host_count             = e->get_host_count();
 347
 348   xbt_assert(host_count > 0, "There is no host!");
 349   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
 350
 351   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
 352   std::copy(begin(hosts), end(hosts), res);
 353
 354   return res;
 355 }
 356
 357 const char* sg_host_get_name(const_sg_host_t host)
 358 {
 359   return host->get_cname();
 360 }
 361
 362 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
 363 {
 364   return host->extension(ext);
 365 }
 366
 367 size_t sg_host_extension_create(void (*deleter)(void*))
 368 {
 369   return simgrid::s4u::Host::extension_create(deleter);
 370 }
 371
 372 sg_host_t sg_host_by_name(const char* name)
 373 {
 374   return simgrid::s4u::Host::by_name_or_null(name);
 375 }
 376
 377 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
 378 {
 379   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
 380
 381   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
 382     return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
 383   });
 384   std::sort(begin(list), last,
 385             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
 386
 387   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
 388   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
 389   return res;
 390 }
 391
 392 // ========= Layering madness ==============*
 393
 394 // ========== User data Layer ==========
 395 void* sg_host_get_data(const_sg_host_t host)
 396 {
 397   return host->get_data();
 398 }
 399 void sg_host_set_data(sg_host_t host, void* userdata)
 400 {
 401   host->set_data(userdata);
 402 }
 403 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 404 {
 405   return sg_host_get_data(host);
 406 }
 407 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
 408 {
 409   sg_host_set_data(host, userdata);
 410 }
 411
 412 // ========= Disk related functions ============
 413 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
 414 {
 415   std::vector<sg_disk_t> list = host->get_disks();
 416   *disk_count                 = list.size();
 417   *disks                      = xbt_new(sg_disk_t, list.size());
 418   std::copy(begin(list), end(list), *disks);
 419 }
 420
 421 // =========== user-level functions ===============
 422 // ================================================
 423 /** @brief Returns the total speed of a host */
 424 double sg_host_get_speed(const_sg_host_t host)
 425 {
 426   return host->get_speed();
 427 }
 428
 429 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 430 {
 431   return sg_host_get_speed(host);
 432 }
 433
 434 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
 435  *
 436  * @param  host host to test
 437  * @param pstate_index pstate to test
 438  * @return Returns the processor speed associated with pstate_index
 439  */
 440 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
 441 {
 442   return host->get_pstate_speed(pstate_index);
 443 }
 444
 445 /** @ingroup m_host_management
 446  * @brief Return the number of cores.
 447  *
 448  * @param host a host
 449  * @return the number of cores
 450  */
 451 int sg_host_core_count(const_sg_host_t host)
 452 {
 453   return host->get_core_count();
 454 }
 455
 456 double sg_host_get_available_speed(const_sg_host_t host)
 457 {
 458   return host->get_available_speed();
 459 }
 460
 461 /** @brief Returns the number of power states for a host.
 462  *
 463  *  See also @ref plugin_energy.
 464  */
 465 int sg_host_get_nb_pstates(const_sg_host_t host)
 466 {
 467   return host->get_pstate_count();
 468 }
 469
 470 /** @brief Gets the pstate at which that host currently runs.
 471  *
 472  *  See also @ref plugin_energy.
 473  */
 474 int sg_host_get_pstate(const_sg_host_t host)
 475 {
 476   return host->get_pstate();
 477 }
 478 /** @brief Sets the pstate at which that host should run.
 479  *
 480  *  See also @ref plugin_energy.
 481  */
 482 void sg_host_set_pstate(sg_host_t host, int pstate)
 483 {
 484   host->set_pstate(pstate);
 485 }
 486
 487 /** @ingroup m_host_management
 488  *
 489  * @brief Start the host if it is off
 490  *
 491  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
 492  * for more info on DVFS.
 493  */
 494 void sg_host_turn_on(sg_host_t host)
 495 {
 496   host->turn_on();
 497 }
 498
 499 /** @ingroup m_host_management
 500  *
 501  * @brief Stop the host if it is on
 502  *
 503  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
 504  * for more info on DVFS.
 505  */
 506 void sg_host_turn_off(sg_host_t host)
 507 {
 508   host->turn_off();
 509 }
 510
 511 /** @ingroup m_host_management
 512  * @brief Determine if a host is up and running.
 513  *
 514  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
 515  * info on DVFS.
 516  *
 517  * @param host host to test
 518  * @return Returns true if the host is up and running, and false if it's currently down
 519  */
 520 int sg_host_is_on(const_sg_host_t host)
 521 {
 522   return host->is_on();
 523 }
 524
 525 /** @brief Get the properties of a host */
 526 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
 527 {
 528   const std::unordered_map<std::string, std::string>* props = host->get_properties();
 529   xbt_dict_t as_dict                                        = xbt_dict_new_homogeneous(xbt_free_f);
 530
 531   if (props == nullptr)
 532     return nullptr;
 533   for (auto const& elm : *props) {
 534     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
 535   }
 536   return as_dict;
 537 }
 538
 539 /** @ingroup m_host_management
 540  * @brief Returns the value of a given host property
 541  *
 542  * @param host a host
 543  * @param name a property name
 544  * @return value of a property (or nullptr if property not set)
 545  */
 546 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
 547 {
 548   return host->get_property(name);
 549 }
 550
 551 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
 552 {
 553   host->set_property(name, value);
 554 }
 555
 556 /**
 557  * @brief Find a route between two hosts
 558  *
 559  * @param from where from
 560  * @param to where to
 561  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
 562  */
 563 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
 564 {
 565   std::vector<simgrid::s4u::Link*> vlinks;
 566   from->route_to(to, vlinks, nullptr);
 567   for (auto const& link : vlinks)
 568     xbt_dynar_push(links, &link);
 569 }
 570 /**
 571  * @brief Find the latency of the route between two hosts
 572  *
 573  * @param from where from
 574  * @param to where to
 575  */
 576 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
 577 {
 578   std::vector<simgrid::s4u::Link*> vlinks;
 579   double res = 0;
 580   from->route_to(to, vlinks, &res);
 581   return res;
 582 }
 583 /**
 584  * @brief Find the bandwidth of the route between two hosts
 585  *
 586  * @param from where from
 587  * @param to where to
 588  */
 589 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
 590 {
 591   double min_bandwidth = -1.0;
 592
 593   std::vector<simgrid::s4u::Link*> vlinks;
 594   from->route_to(to, vlinks, nullptr);
 595   for (auto const& link : vlinks) {
 596     double bandwidth = link->get_bandwidth();
 597     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
 598       min_bandwidth = bandwidth;
 599   }
 600   return min_bandwidth;
 601 }
 602
 603 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
 604 {
 605   sg_host_get_route(from, to, links);
 606 }
 607
 608 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 609 {
 610   return sg_host_get_route_latency(from, to);
 611 }
 612
 613 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
 614 {
 615   return sg_host_get_route_bandwidth(from, to);
 616 }
 617
 618 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
 619 {
 620   simgrid::s4u::Comm::sendto(from, 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_get_load(const_sg_host_t host)
 669 {
 670   return host->get_load();
 671 }
 672
 673 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
 674 {
 675   return sg_host_get_load(host);
 676 }